ilCASAuth Class Reference

Class CASAuth. More...

Inheritance diagram for ilCASAuth:

Collaboration diagram for ilCASAuth:

Public Member Functions
	ilCASAuth ($a_params)
	Constructor public. More...
	checkCASAuth ()
	check cas autehntication More...
	forceCASAuth ()
	getCASUser ()
	login ()
	Checks if the current user is authenticated yet public. More...
	logout ()
	Register variable in a session telling that the user has logged in successfully. More...
Public Member Functions inherited from Auth
	Auth ($storageDriver, $options='', $loginFunction='', $showLogin=true)
	Constructor. More...
&	applyAuthOptions (&$options)
	Set the Auth options. More...
	_loadStorage ()
	Load Storage Driver if not already loaded. More...
	assignData ()
	Assign data from login form to internal values. More...
	start ()
	Start new auth session. More...
	login ()
	Login function. More...
	setExpire ($time, $add=false)
	Set the maximum expire time. More...
	setIdle ($time, $add=false)
	Set the maximum idle time. More...
	setSessionName ($name='session')
	Set name of the session to a customized value. More...
	setShowLogin ($showLogin=true)
	Should the login form be displayed if neccessary? More...
	setAllowLogin ($allowLogin=true)
	Should the login form be displayed if neccessary? More...
	setCheckAuthCallback ($checkAuthCallback)
	Register a callback function to be called whenever the validity of the login is checked The function will receive two parameters, the username and a reference to the auth object. More...
	setLoginCallback ($loginCallback)
	Register a callback function to be called on user login. More...
	setFailedLoginCallback ($loginFailedCallback)
	Register a callback function to be called on failed user login. More...
	setLogoutCallback ($logoutCallback)
	Register a callback function to be called on user logout. More...
	setAuthData ($name, $value, $overwrite=true)
	Register additional information that is to be stored in the session. More...
	getAuthData ($name=null)
	Get additional information that is stored in the session. More...
	setAuth ($username)
	Register variable in a session telling that the user has logged in successfully. More...
	setAdvancedSecurity ($flag=true)
	Enables advanced security checks. More...
	checkAuth ()
	Checks if there is a session with valid auth information. More...
	getAuth ()
	Has the user been authenticated? More...
	logout ()
	Logout function. More...
	updateIdle ()
	Update the idletime. More...
	getUsername ()
	Get the username. More...
	getStatus ()
	Get the current status. More...
	getPostUsernameField ()
	Gets the post varible used for the username. More...
	getPostPasswordField ()
	Gets the post varible used for the username. More...
	sessionValidThru ()
	Returns the time up to the session is valid. More...
	listUsers ()
	List all users that are currently available in the storage container. More...
	addUser ($username, $password, $additional='')
	Add user to the storage container. More...
	removeUser ($username)
	Remove user from the storage container. More...
	changePassword ($username, $password)
	Change password for user in the storage container. More...
	log ($message, $level=AUTH_LOG_DEBUG)
	Log a message from the Auth system. More...
	_loadLogger ()
	Load Log object if not already loaded. More...
	attachLogObserver (&$observer)
	Attach an Observer to the Auth Log Source. More...
	_isAdvancedSecurityEnabled ($feature=null)
	Is advanced security enabled? More...
Public Member Functions inherited from ilAuthBase
	getSubStatus ()
	Get sub status. More...
	setSubStatus ($a_sub_status)
	Set sub status. More...
	supportsRedirects ()
	Returns true, if the current auth mode allows redirects to e.g the login screen, public section ... More...
	getContainer ()
	Get container object. More...
	getExceededUserName ()

Additional Inherited Members
Static Public Member Functions inherited from Auth
&	_factory ($driver, $options='')
	Return a storage driver based on $driver and $options. More...
	staticCheckAuth ($options=null)
	Statically checks if there is a session with valid auth information. More...
Data Fields inherited from Auth
	$expire = 0
	$expired = false
	$idle = 0
	$idled = false
	$storage = ''
	$loginFunction = ''
	$showLogin = true
	$allowLogin = true
	$status = ''
	$username = ''
	$password = ''
	$checkAuthCallback = ''
	$loginCallback = ''
	$loginFailedCallback = ''
	$logoutCallback = ''
	$_sessionName = '_authsession'
	$version = "@version@"
	$advancedsecurity = false
	$_postUsername = 'username'
	$_postPassword = 'password'
	$session
	$server
	$post
	$cookie
	$authdata
	$authChecks = 0
	$logger = null
	$enableLogging = false
	$regenerateSessionId = false
Protected Member Functions inherited from ilAuthBase
	initAuth ()
	Init auth object Enable logging, set callbacks... More...
	loginObserver ($a_username, $a_auth)
	Called after successful login. More...
	failedLoginObserver ($a_username, $a_auth)
	Called after failed login. More...
	checkAuthObserver ($a_username, $a_auth)
	Called after each check auth request. More...
	logoutObserver ($a_username, $a_auth)
	Called after logout. More...
Protected Attributes inherited from ilAuthBase
	$sub_status = null
	$exceeded_user_name

Detailed Description

Class CASAuth.

CAS Authentication class.

Definition at line 37 of file class.ilCASAuth.php.

Member Function Documentation

checkCASAuth()

ilCASAuth::checkCASAuth

(

)

check cas autehntication

can be called before forceAuthentication, but forceAuthentication must be called afterwards

Definition at line 72 of file class.ilCASAuth.php.

References $PHPCAS_CLIENT.

        {
                global $PHPCAS_CLIENT;

                return $PHPCAS_CLIENT->isAuthenticated();
        }

forceCASAuth()

ilCASAuth::forceCASAuth

(

)

Definition at line 79 of file class.ilCASAuth.php.

References phpCAS\forceAuthentication().

        {
                phpCAS::forceAuthentication();
        }

Here is the call graph for this function:

getCASUser()

ilCASAuth::getCASUser

(

)

Definition at line 84 of file class.ilCASAuth.php.

References phpCAS\getUser().

        {
                return phpCAS::getUser();
        }

Here is the call graph for this function:

ilCASAuth()

ilCASAuth::ilCASAuth

(

$a_params

)

Constructor public.

Definition at line 43 of file class.ilCASAuth.php.

References CAS_VERSION_2_0, and phpCAS\client().

        {
                if ($a_params["sessionName"] != "")
                {
                        parent::Auth("", array("sessionName" => $a_params["sessionName"]));
                }
                else
                {
                        parent::Auth("");
                }
                
                include_once("./Services/CAS/lib/CAS.php");
                $this->server_version = CAS_VERSION_2_0;
                $this->server_hostname = $a_params["server_hostname"];
                $this->server_port = (int) $a_params["server_port"];
                $this->server_uri = $a_params["server_uri"];

                //phpCAS::setDebug();
//echo "-".$_GET['ticket']."-"; exit;
                phpCAS::client($this->server_version, $this->server_hostname,
                        $this->server_port, (string) $this->server_uri);
        }

Here is the call graph for this function:

login()

ilCASAuth::login

(

)

Checks if the current user is authenticated yet public.

Returns

boolean true if user is authenticated Set the maximum idle time

Parameters

integer	time in seconds
bool	add time to current maximum idle time or not

Returns

void public Set the maximum expire time

Parameters

integer	time in seconds
bool	add time to current expire time or not

Returns

void public Checks if there is a session with valid auth information.

private

Returns

boolean Whether or not the user is authenticated. Start new auth session

public

Returns

void Login function

private

Returns

void

Definition at line 213 of file class.ilCASAuth.php.

References $ilSetting, Auth\$username, ilObjUser\_checkExternalAuthAccount(), ilAuthUtils\_generateLogin(), AUTH_CAS_NO_ILIAS_USER, AUTH_WRONG_LOGIN, phpCAS\getUser(), IL_PASSWD_CRYPTED, logout(), and Auth\setAuth().

        {
                global $ilias, $rbacadmin, $ilSetting;

                if (phpCAS::getUser() != "")
                {
                        $username = phpCAS::getUser();

                        // Authorize this user
                        include_once('./Services/User/classes/class.ilObjUser.php');
                        $local_user = ilObjUser::_checkExternalAuthAccount("cas", $username);

                        if ($local_user != "")
                        {
                                $this->setAuth($local_user);
                        }
                        else
                        {
                                if (!$ilSetting->get("cas_create_users"))
                                {
                                        $this->status = AUTH_CAS_NO_ILIAS_USER;
                                        $this->logout();
                                        return;
                                }
                                
                                $userObj = new ilObjUser();
                                
                                $local_user = ilAuthUtils::_generateLogin($username);
                                
                                $newUser["firstname"] = $local_user;
                                $newUser["lastname"] = "";
                                
                                $newUser["login"] = $local_user;
                                
                                // set "plain md5" password (= no valid password)
                                $newUser["passwd"] = ""; 
                                $newUser["passwd_type"] = IL_PASSWD_CRYPTED;
                                                                
                                //$newUser["gender"] = "m";
                                $newUser["auth_mode"] = "cas";
                                $newUser["ext_account"] = $username;
                                $newUser["profile_incomplete"] = 1;
                                
                                // 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(1);
                                $userObj->setTimeLimitFrom(time());
                                $userObj->setTimeLimitUntil(time());
                                                                
                                // Create user in DB
                                $userObj->setOwner(0);
                                $userObj->create();
                                $userObj->setActive(1);
                                
                                $userObj->updateOwner();
                                
                                //insert user data in table user_data
                                $userObj->saveAsNew();
                                
                                // setup user preferences
                                $userObj->writePrefs();
                                
                                // to do: test this
                                $rbacadmin->assignUser($ilSetting->get('cas_user_default_role'), $userObj->getId(),true);

                                unset($userObj);
                                
                                $this->setAuth($local_user);

                        }
                }
                else
                {
                        // This should never occur unless CAS is not configured properly
                        $this->status = AUTH_WRONG_LOGIN;
                }
        }

Here is the call graph for this function:

logout()

ilCASAuth::logout

(

)

Register variable in a session telling that the user has logged in successfully.

public

Parameters

string

Username

Returns

void Logout function

This function clears any auth tokens in the currently active session and executes the logout callback function, if any

public

Returns

void

Definition at line 341 of file class.ilCASAuth.php.

Referenced by login().

        {
                parent::logout();
                //PHPCAS::logout();             // CAS logout should be provided separately
                                                                // maybe on ILISA login screen
        }

Here is the caller graph for this function:

---

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

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