ILIAS  release_7 Revision v7.30-3-g800a261c036
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$statusAuthentication status
Returns
bool
More...
 
- Public Member Functions inherited from ilAuthProvider
 __construct (ilAuthCredentials $credentials)
 Constructor. More...
 
 getLogger ()
 Get logger. More...
 
 getCredentials ()
 
 doAuthentication (\ilAuthStatus $status)
 Do authentication. More...
 

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

Reimplemented from ilAuthProvider.

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

25 {
26 global $DIC;
27
29 include_once './Services/CAS/classes/class.ilCASSettings.php';
31 }
static getInstance()
Get singleton instance.
global $DIC
Definition: goto.php:24
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
settings()
Definition: settings.php:2

References ilAuthProvider\$credentials, $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilCASSettings\getInstance(), and settings().

+ Here is the call graph for this function:

Member Function Documentation

◆ doAuthentication()

ilAuthProviderCAS::doAuthentication ( \ilAuthStatus  $status)

Do authentication.

Parameters
\ilAuthStatus$statusAuthentication status
Returns
bool

Implements ilAuthProviderInterface.

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

45 {
46 include_once './Services/CAS/lib/CAS.php';
47 global $phpCAS;
48
49 $this->getLogger()->debug('Starting cas authentication attempt... ');
50
51 try {
52 phpCAS::setDebug(false);
56 $this->getSettings()->getServer(),
57 (int) $this->getSettings()->getPort(),
58 $this->getSettings()->getUri()
59 );
60
63 } catch (Exception $e) {
64 $this->getLogger()->error('Cas authentication failed with message: ' . $e->getMessage());
65 $this->handleAuthenticationFail($status, 'err_wrong_login');
66 return false;
67 }
68
69 if (!strlen(phpCAS::getUser())) {
70 return $this->handleAuthenticationFail($status, 'err_wrong_login');
71 }
72 $this->getCredentials()->setUsername(phpCAS::getUser());
73
74 // check and handle ldap data sources
75 include_once './Services/LDAP/classes/class.ilLDAPServer.php';
77 return $this->handleLDAPDataSource($status);
78 }
79
80 // Check account available
81 $local_user = ilObjUser::_checkExternalAuthAccount("cas", $this->getCredentials()->getUsername());
82 if (strlen($local_user)) {
83 $this->getLogger()->debug('CAS authentication successful.');
85 $status->setAuthenticatedUserId(ilObjUser::_lookupId($local_user));
86 return true;
87 }
88
89 if (!$this->getSettings()->isUserCreationEnabled()) {
90 $this->getLogger()->debug('User creation disabled. No valid local account found');
91 $this->handleAuthenticationFail($status, 'err_auth_cas_no_ilias_user');
92 return false;
93 }
94
95
96 include_once './Services/CAS/classes/class.ilCASAttributeToUser.php';
97 $importer = new ilCASAttributeToUser($this->getSettings());
98 $new_name = $importer->create($this->getCredentials()->getUsername());
99
100 if (!strlen($new_name)) {
101 $this->getLogger()->debug('User creation failed.');
102 $this->handleAuthenticationFail($status, 'err_auth_cas_no_ilias_user');
103 return false;
104 }
105
107 $status->setAuthenticatedUserId(ilObjUser::_lookupId($new_name));
108 return true;
109 }
const AUTH_CAS
handleLDAPDataSource(\ilAuthStatus $status)
Handle user data synchonization by ldap data source.
getLogger()
Get logger.
handleAuthenticationFail(ilAuthStatus $status, $a_reason)
Handle failed authentication.
CAS user creation helper.
static isDataSourceActive($a_auth_mode)
Check if a data source is active for a specific auth mode @global ilDB $ilDB.
static _checkExternalAuthAccount($a_auth, $a_account, $tryFallback=true)
check whether external account and authentication method matches with a user
static _lookupId($a_user_str)
Lookup id by login.
static getUser()
This method returns the CAS user's login name.
Definition: CAS.php:1199
static forceAuthentication()
This method is called to force authentication if the user was not already authenticated.
Definition: CAS.php:1118
static setNoCasServerValidation()
Set no SSL validation for the CAS server.
Definition: CAS.php:1663
static setDebug($filename='')
Set/unset debug mode.
Definition: CAS.php:462
static setVerbose($verbose)
Enable verbose errors messages in the website output This is a security relevant since internal statu...
Definition: CAS.php:503
static client( $server_version, $server_hostname, $server_port, $server_uri, $changeSessionID=true)
phpCAS client initializer.
Definition: CAS.php:345
const CAS_VERSION_2_0
Definition: CAS.php:78

References Vendor\Package\$e, ilAuthProvider\$status, 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(), phpCAS\setDebug(), phpCAS\setNoCasServerValidation(), ilAuthStatus\setStatus(), phpCAS\setVerbose(), and ilAuthStatus\STATUS_AUTHENTICATED.

+ Here is the call graph for this function:

◆ getSettings()

ilAuthProviderCAS::getSettings ( )
protected
Returns
\ilCASSettings

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

References $settings.

Referenced by doAuthentication().

+ 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 115 of file class.ilAuthProviderCAS.php.

116 {
117 include_once './Services/LDAP/classes/class.ilLDAPServer.php';
120 );
121
122 $this->getLogger()->debug('Using ldap data source for user: ' . $this->getCredentials()->getUsername());
123
124 include_once './Services/LDAP/classes/class.ilLDAPUserSynchronisation.php';
125 $sync = new ilLDAPUserSynchronisation('cas', $server->getServerId());
126 $sync->setExternalAccount($this->getCredentials()->getUsername());
127 $sync->setUserData(array());
128 $sync->forceCreation(true);
129
130 try {
131 $internal_account = $sync->sync();
132 } catch (UnexpectedValueException $e) {
133 $this->getLogger()->warning('Authentication failed with message: ' . $e->getMessage());
134 $this->handleAuthenticationFail($status, 'err_wrong_login');
135 return false;
137 $this->handleAuthenticationFail($status, 'err_auth_ldap_failed');
138 return false;
140 // No syncronisation allowed => create Error
141 $this->getLogger()->warning('User creation disabled. No valid local account found');
142 $this->handleAuthenticationFail($status, 'err_auth_cas_no_ilias_user');
143 return false;
145
146 // No syncronisation allowed => create Error
147 $this->getLogger()->warning('User creation disabled. No valid local account found');
148 $this->handleAuthenticationFail($status, 'err_auth_cas_no_ilias_user');
149 return false;
150 }
152 $status->setAuthenticatedUserId(ilObjUser::_lookupId($internal_account));
153 return true;
154 }
Description of ilLDAPAccountMigrationRequiredException.
static getDataSource($a_auth_mode)
static getInstanceByServerId($a_server_id)
Get instance by server id.
Thrown in case of failed synchronisation settings.
Synchronization of user accounts used in auth container ldap, radius , cas,...
$server

References Vendor\Package\$e, $server, ilAuthProvider\$status, ilObjUser\_lookupId(), AUTH_CAS, ilAuthProvider\getCredentials(), ilLDAPServer\getDataSource(), ilLDAPServer\getInstanceByServerId(), ilAuthProvider\getLogger(), ilAuthProvider\handleAuthenticationFail(), and ilAuthStatus\STATUS_AUTHENTICATED.

Referenced by doAuthentication().

+ 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: