ilCASAuth Class Reference

Class CASAuth. More...

Inheritance diagram for ilCASAuth:

Collaboration diagram for ilCASAuth:

Public Member Functions
	__construct ($a_params)
	Constructor @access public. More...
	checkCASAuth ()
	check cas autehntication More...
	forceCASAuth ()
	getCASUser ()
	login ()
	Checks if the current user is authenticated yet @access public. More...
	logout ()
	Register variable in a session telling that the user has logged in successfully. More...

Additional Inherited Members
Static Public Member Functions inherited from SimpleSAML\Utils\Auth
static	getAdminLoginURL ($returnTo=null)
	Retrieve a admin login URL. More...
static	isAdmin ()
	Check whether the current user is admin. More...
static	requireAdmin ()
	Require admin access to the current page. More...

Detailed Description

Class CASAuth.

CAS Authentication class.

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

Constructor & Destructor Documentation

__construct()

ilCASAuth::__construct

(

$a_params

)

Constructor @access public.

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

    {
        if ($a_params["sessionName"] != "") {
            parent::__construct("", array("sessionName" => $a_params["sessionName"]));
        } else {
            parent::__construct("");
        }
        
        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
        );
    }

References CAS_VERSION_2_0, and phpCAS\client().

Here is the call graph for this function:

Member Function Documentation

checkCASAuth()

ilCASAuth::checkCASAuth

(

)

check cas autehntication

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

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

    {
        global $PHPCAS_CLIENT;
 
        return $PHPCAS_CLIENT->isAuthenticated();
    }

forceCASAuth()

ilCASAuth::forceCASAuth

(

)

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

    {
        phpCAS::forceAuthentication();
    }

References phpCAS\forceAuthentication().

Here is the call graph for this function:

getCASUser()

ilCASAuth::getCASUser

(

)

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

    {
        return phpCAS::getUser();
    }

References phpCAS\getUser().

Here is the call graph for this function:

login()

ilCASAuth::login

(

)

Checks if the current user is authenticated yet @access 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 @access public Set the maximum expire time

Parameters

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

Returns

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

@access private

Returns

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

@access public

Returns

void Login function

@access private

Returns

void

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

    {
        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;
        }
    }

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

Here is the call graph for this function:

logout()

ilCASAuth::logout

(

)

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

@access 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

@access public

Returns

void

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

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

Referenced by login().

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