class.ilBaseAuthentication.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */


include_once 'Auth/Auth.php';

define('IL_AUTH_MD5',1);
define('IL_AUTH_PLAIN',2);

class ilBaseAuthentication
{

        /*
         * Pear object (Auth) 
         * @var object
         */
        var $auth = null;



        /*
         * session id
         * @var string
         */
        var $sid = '';

        /*
         * username
         * @var string
         */
        var $username = '';

        /*
         * password
         * @var string
         */
        var $password = '';


        /*
         * client id
         * @var string
         */
        var $client = '';

        function ilBaseAuthentication()
        {
                $this->__setMessage('');
                $this->__setMessageCode('Client');
                $this->check_setting = true;
        }


        // Set/Get
        function setClient($a_client)
        {
                $this->client = $a_client;
                $_COOKIE['ilClientId'] = $a_client;
        }
        function getClient()
        {
                return $this->client;
        }
        function setUsername($a_username)
        {
                $this->username = $a_username;
                $_POST['username'] = $a_username;
        }
        function getUsername()
        {
                return $this->username;
        }
        function setPassword($a_password)
        {
                $this->password = $a_password;
                $_POST['password'] = $a_password;
        }
        function getPassword()
        {
                return $this->password;
        }
        function setSid($a_sid)
        {
                $this->sid = $a_sid;
                $_COOKIE['PHPSESSID'] = $this->sid;
        }
        function getSid()
        {
                return $this->sid;
        }

        function getMessage()
        {
                return $this->message;
        }
        function getMessageCode()
        {
                return $this->message_code;
        }
        function __setMessage($a_message)
        {
                $this->message = $a_message;
        }
        function __setMessageCode($a_message_code)
        {
                $this->message_code = $a_message_code;
        }

        function setPasswordType($a_type)
        {
                $this->password_type = $a_type;
        }
        function getPasswordType()
        {
                return isset($this->password_type) ? $this->password_type : IL_AUTH_PLAIN;
        }

        function authenticate()
        {
                if(!$this->getClient())
                {
                        $this->__setMessage('No client given');
                        return false;
                }
                if(!$this->getUsername())
                {
                        $this->__setMessage('No username given');
                        return false;
                }
                // Read ilias ini
                if(!$this->__buildDSN())
                {
                        return false;
                }
                if(!$this->__setSessionSaveHandler())
                {
                        return false;
                }
                if(!$this->__buildAuth())
                {
                        return false;
                }
                $this->auth->start();

                if(!$this->auth->getAuth())
                {
                        $this->__getAuthStatus();

                        return false;
                }                       

                $this->setSid(session_id());

                return true;
        }

        function start()
        {
                if(!$this->getSid())
                {
                        $this->__setMessage('No session id given');
                        return false;
                }

                $this->auth->start();

                return true;
        }
        
        function validateSession()
        {
                if(!$this->getClient())
                {
                        $this->__setMessage('No client given');
                        return false;
                }
                if(!$this->getSid())
                {
                        $this->__setMessage('No session id given');
                        return false;
                }
                
                if(!$this->__buildAuth())
                {
                        return false;
                }
                if(!$this->__setSessionSaveHandler())
                {
                        return false;
                }

                $this->auth->start();
                if(!$this->auth->getAuth())
                {
                        $this->__setMessage('Session not valid');
                        
                        return false;
                }
                
                return true;
        }

        function logout()
        {
                if(!$this->getClient())
                {
                        $this->__setMessage('No client given');
                        return false;
                }
                if(!$this->getSid())
                {
                        $this->__setMessage('No session id given');
                        return false;
                }
                // logged auth users are authenticated
                // No preperations are required
                #if(!$this->__buildAuth())
                #{
                #       return false;
                #}
                #if(!$this->__setSessionSaveHandler())
                #{
                #       return false;
                #}
                
                // And finally logout
                #$this->auth->start();
                $this->auth->logout();
                session_destroy();

                return true;

        }

        function __buildDSN()
        {
                include_once './Services/Init/classes/class.ilIniFile.php';

                // get ilias ini file
                $this->ilias_ini =& new ilIniFile('./ilias.ini.php');
                $this->ilias_ini->read();

                if(!@file_exists("./".$this->ilias_ini->readVariable('clients','path')."/".$this->getClient()."/client.ini.php"))
                {
                        $this->__setMessageCode('Client');
                        $this->__setMessage('Client does not exist');

                        return false;
                }
                
                $this->ini =& new ilIniFile("./".$this->ilias_ini->readVariable('clients','path')."/".$this->getClient()."/client.ini.php");
                $this->ini->read();
                
                include_once("./Services/Database/classes/class.ilDBWrapperFactory.php");
                $this->db = ilDBWrapperFactory::getWrapper($this->ini->readVariable("db","type"),
                        $this->ini->readVariable("db","inactive_mysqli"));
                $this->db->setDBUser($this->ini->readVariable("db", "user"));
                $this->db->setDBPassword($this->ini->readVariable("db", "pass"));
                $this->db->setDBName($this->ini->readVariable("db", "name"));
                $this->db->setDBHost($this->ini->readVariable("db", "host"));
                $this->dsn = $this->db->getDSN();

                return true;
        }               

        function __buildAuth()
        {
                
                // BEGIN WebDAV
                // The realm is needed to support a common session between Auth_HTTP and Auth.
                // It also helps us to distinguish between parallel sessions run on different clients.
                // Common session only works if we use a common session name starting with "_authhttp".
                // We must use the "_authttp" prefix, because it is hardcoded in the session name of
                // class Auth_HTTP.
                // Note: The realm and sessionName used here, must be the same as in 
                //       class ilAuthUtils. Otherwise, Soap clients won't be able to log
                //       in to ILIAS.
                $realm = $this->getClient();
                // END WebDAV

                $this->auth_params = array(
                        'dsn'             => $this->db->getDSN(),
                        'table'       => $this->ini->readVariable("auth", "table"),
                        'usernamecol' => $this->ini->readVariable("auth", "usercol"),
                        'passwordcol' => $this->ini->readVariable("auth", "passcol"),
                        'sessionName' => "_authhttp".md5($realm)
                        );

                if($this->getPasswordType() == IL_AUTH_MD5)
                {
                        $this->auth_params['cryptType'] = 'none';
                }

                include_once './Services/Authentication/classes/class.ilAuthContainerDatabase.php';
                $authContainerDB = new ilAuthContainerDatabase($this->auth_params);
                $this->auth = new Auth($authContainerDB, $this->auth_params,"",false);

                return true;
        }

        function __setSessionSaveHandler()
        {
                require_once "./Services/Authentication/classes/class.ilSessionDBHandler.php";
                include_once "./Services/Utilities/classes/class.ilUtil.php";
                include_once './Services/Init/classes/class.ilErrorHandling.php';
                include_once './Services/Database/classes/class.ilDB.php';

                $this->db->connect();
                $GLOBALS['ilDB'] = $this->db;

                if(ini_get('session.save_handler') != 'user')
                {
                        ini_set("session.save_handler", "user");
                }
                $db_session_handler = new ilSessionDBHandler();
                if (!$db_session_handler->setSaveHandler())
                {
                        $this->__setMessageCode('Server');
                        $this->__setMessage('Cannot set session handler');

                        return false;
                }

                return true;
        }

        function __getAuthStatus()
        {
                switch($this->auth->getStatus())
                {
                        case AUTH_EXPIRED:
                                $this->__setMessageCode('Server');
                                $this->__setMessage('Session expired');

                                return false;

                        case AUTH_IDLED:
                                $this->__setMessageCode('Server');
                                $this->__setMessage('Session idled');
                                
                                return false;
                                
                        case AUTH_WRONG_LOGIN:
                        default:
                                $this->__setMessageCode('Client');
                                $this->__setMessage('Wrong Login or Password');

                                return false;
                                
                                
                }
        }
}
?>