class.ilCASAuth.php

Go to the documentation of this file.

<?php
/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
    +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
    |                                                                             |
    | This program is free software; you can redistribute it and/or               |
    | modify it under the terms of the GNU General Public License                 |
    | as published by the Free Software Foundation; either version 2              |
    | of the License, or (at your option) any later version.                      |
    |                                                                             |
    | This program is distributed in the hope that it will be useful,             |
    | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
    | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
    | GNU General Public License for more details.                                |
    |                                                                             |
    | You should have received a copy of the GNU General Public License           |
    | along with this program; if not, write to the Free Software                 |
    | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
    +-----------------------------------------------------------------------------+
*/
 
 
include_once("Auth/Auth.php");
 
class ilCASAuth extends Auth
{
    public function __construct($a_params)
    {
        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
        );
    }
    
    public function checkCASAuth()
    {
        global $PHPCAS_CLIENT;
 
        return $PHPCAS_CLIENT->isAuthenticated();
    }
    
    public function forceCASAuth()
    {
        phpCAS::forceAuthentication();
    }
    
    public function getCASUser()
    {
        return phpCAS::getUser();
    }
    
    /*
        function getAuth()
        {
            $session = &$this->_importGlobalVariable('session');
            if (!empty($session) &&
            (isset($session[$this->_sessionName]['registered']) &&
            $session[$this->_sessionName]['registered'] === true))
            {
                return true;
            } else {
                return false;
            }
        }
    */
 
    /*
        function setIdle($time, $add = false)
        {
            $add ? $this->idle += $time : $this->idle = $time;
        }
    */
 
    /*
        function setExpire($time, $add = false)
        {
            $add ? $this->expire += $time : $this->expire = $time;
        }
    */
 
    /*
        function checkAuth()
        {
            $session = &$this->_importGlobalVariable('session');
 
            if (isset($session[$this->_sessionName])) {
                // Check if authentication session is expired
                if ($this->expire > 0 &&
                    isset($session[$this->_sessionName]['timestamp']) &&
                    ($session[$this->_sessionName]['timestamp'] + $this->expire) < time()) {
 
                    $this->logout();
                    $this->expired = true;
                    $this->status = AUTH_EXPIRED;
 
                    return false;
                }
 
                // Check if maximum idle time is reached
                if ($this->idle > 0 &&
                    isset($session[$this->_sessionName]['idle']) &&
                    ($session[$this->_sessionName]['idle'] + $this->idle) < time()) {
 
                    $this->logout();
                    $this->idled = true;
                    $this->status = AUTH_IDLED;
 
                    return false;
                }
 
                if (isset($session[$this->_sessionName]['registered']) &&
                    isset($session[$this->_sessionName]['username']) &&
                    $session[$this->_sessionName]['registered'] == true &&
                    $session[$this->_sessionName]['username'] != '') {
 
                    Auth::updateIdle();
 
                    return true;
                }
            }
 
            return false;
        }
    */
    
    /*
        function start()
        {
            @session_start();
 
            if (!$this->checkAuth()) {
                $this->login();
            }
        }
    */
    
    public function login()
    {
        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;
        }
    }
    
    /*
        function setAuth($username)
        {
            $session = &Auth::_importGlobalVariable('session');
 
            if (!isset($session[$this->_sessionName]) && !isset($_SESSION)) {
                session_register($this->_sessionName);
            }
 
            if (!isset($session[$this->_sessionName]) || !is_array($session[$this->_sessionName])) {
                $session[$this->_sessionName] = array();
            }
 
            if(!isset($session[$this->_sessionName]['data'])){
                $session[$this->_sessionName]['data']       = array();
            }
                $session[$this->_sessionName]['registered'] = true;
                $session[$this->_sessionName]['username']   = $username;
                $session[$this->_sessionName]['timestamp']  = time();
                $session[$this->_sessionName]['idle']       = time();
        }
    */
    
    public function logout()
    {
        parent::logout();
        //PHPCAS::logout();             // CAS logout should be provided separately
                                // maybe on ILISA login screen
    }
    
/*
    function getUsername()
    {
        $session = &$this->_importGlobalVariable('session');
        if (!isset($session[$this->_sessionName]['username'])) {
            return '';
        }
        return $session[$this->_sessionName]['username'];
    }
*/
    
/*
    function getStatus()
    {
 
        return $status;
    }
*/
    
/*
    function &_importGlobalVariable($variable)
    {
        $var = null;
 
        switch (strtolower($variable)) {
 
            case 'server' :
                if (isset($_SERVER)) {
                    $var = &$_SERVER;
                } else {
                    $var = &$GLOBALS['HTTP_SERVER_VARS'];
                }
                break;
 
            case 'session' :
                if (isset($_SESSION)) {
                    $var = &$_SESSION;
                } else {
                    $var = &$GLOBALS['HTTP_SESSION_VARS'];
                }
                break;
 
            case 'post' :
                if (isset($_POST)) {
                    $var = &$_POST;
                } else {
                    $var = &$GLOBALS['HTTP_POST_VARS'];
                }
                break;
 
            case 'cookie' :
                if (isset($_COOKIE)) {
                    $var = &$_COOKIE;
                } else {
                    $var = &$GLOBALS['HTTP_COOKIE_VARS'];
                }
                break;
 
            case 'get' :
                if (isset($_GET)) {
                    $var = &$_GET;
                } else {
                    $var = &$GLOBALS['HTTP_GET_VARS'];
                }
                break;
 
            default:
                break;
 
        }
 
        return $var;
    }
*/
} // END class.ilCASAuth