ilBaseAuthentication Class Reference

Inheritance diagram for ilBaseAuthentication:

Collaboration diagram for ilBaseAuthentication:

Public Member Functions
	__construct ()
	setClient ($a_client)
	getClient ()
	setUsername ($a_username)
	getUsername ()
	setPassword ($a_password)
	getPassword ()
	setSid ($a_sid)
	getSid ()
	getMessage ()
	getMessageCode ()
	__setMessage ($a_message)
	__setMessageCode ($a_message_code)
	setPasswordType ($a_type)
	getPasswordType ()
	authenticate ()
	start ()
	validateSession ()
	logout ()
	__buildDSN ()
	__buildAuth ()
	__setSessionSaveHandler ()
	__getAuthStatus ()

Data Fields
	$auth = null
	$sid = ''
	$username = ''
	$password = ''
	$client = ''

Detailed Description

Definition at line 19 of file class.ilBaseAuthentication.php.

Constructor & Destructor Documentation

__construct()

ilBaseAuthentication::__construct

(

)

Definition at line 55 of file class.ilBaseAuthentication.php.

References __setMessage(), and __setMessageCode().

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

Here is the call graph for this function:

Member Function Documentation

__buildAuth()

ilBaseAuthentication::__buildAuth

(

)

Definition at line 275 of file class.ilBaseAuthentication.php.

References array, getClient(), getPasswordType(), and IL_AUTH_MD5.

Referenced by ilSoapAuthentication\authenticate(), authenticate(), ilSoapAuthentication\validateSession(), and validateSession().

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

Here is the call graph for this function:

Here is the caller graph for this function:

__buildDSN()

ilBaseAuthentication::__buildDSN

(

)

Definition at line 244 of file class.ilBaseAuthentication.php.

References __setMessage(), __setMessageCode(), and getClient().

Referenced by ilSoapAuthentication\authenticate(), authenticate(), and ilSoapAuthentication\validateSession().

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

Here is the call graph for this function:

Here is the caller graph for this function:

__getAuthStatus()

ilBaseAuthentication::__getAuthStatus

(

)

Definition at line 336 of file class.ilBaseAuthentication.php.

References __setMessage(), and __setMessageCode().

Referenced by ilSoapAuthentication\authenticate(), and authenticate().

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

Here is the call graph for this function:

Here is the caller graph for this function:

__setMessage()

ilBaseAuthentication::__setMessage

(

$a_message

)

Definition at line 109 of file class.ilBaseAuthentication.php.

Referenced by __buildDSN(), ilSoapAuthentication\__checkAgreement(), __construct(), __getAuthStatus(), __setSessionSaveHandler(), ilSoapAuthentication\authenticate(), authenticate(), logout(), start(), ilSoapAuthentication\validateSession(), and validateSession().

        {
                $this->message = $a_message;
        }

Here is the caller graph for this function:

__setMessageCode()

ilBaseAuthentication::__setMessageCode

(

$a_message_code

)

Definition at line 113 of file class.ilBaseAuthentication.php.

Referenced by __buildDSN(), ilSoapAuthentication\__construct(), __construct(), __getAuthStatus(), __setSessionSaveHandler(), ilSoapAuthentication\authenticate(), and ilSoapAuthentication\validateSession().

        {
                $this->message_code = $a_message_code;
        }

Here is the caller graph for this function:

__setSessionSaveHandler()

ilBaseAuthentication::__setSessionSaveHandler

(

)

Definition at line 310 of file class.ilBaseAuthentication.php.

References $GLOBALS, __setMessage(), and __setMessageCode().

Referenced by ilSoapAuthentication\authenticate(), authenticate(), ilSoapAuthentication\validateSession(), and validateSession().

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

Here is the call graph for this function:

Here is the caller graph for this function:

authenticate()

ilBaseAuthentication::authenticate

(

)

Definition at line 127 of file class.ilBaseAuthentication.php.

References __buildAuth(), __buildDSN(), __getAuthStatus(), __setMessage(), __setSessionSaveHandler(), getClient(), getUsername(), and setSid().

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

Here is the call graph for this function:

getClient()

ilBaseAuthentication::getClient

(

)

Definition at line 69 of file class.ilBaseAuthentication.php.

References $client.

Referenced by __buildAuth(), __buildDSN(), ilSoapAuthentication\authenticate(), authenticate(), logout(), ilSoapAuthentication\validateSession(), and validateSession().

        {
                return $this->client;
        }

Here is the caller graph for this function:

getMessage()

ilBaseAuthentication::getMessage

(

)

Definition at line 101 of file class.ilBaseAuthentication.php.

        {
                return $this->message;
        }

getMessageCode()

ilBaseAuthentication::getMessageCode

(

)

Definition at line 105 of file class.ilBaseAuthentication.php.

        {
                return $this->message_code;
        }

getPassword()

ilBaseAuthentication::getPassword

(

)

Definition at line 87 of file class.ilBaseAuthentication.php.

References $password.

        {
                return $this->password;
        }

getPasswordType()

ilBaseAuthentication::getPasswordType

(

)

Definition at line 122 of file class.ilBaseAuthentication.php.

References IL_AUTH_PLAIN.

Referenced by __buildAuth().

        {
                return isset($this->password_type) ? $this->password_type : IL_AUTH_PLAIN;
        }

Here is the caller graph for this function:

getSid()

ilBaseAuthentication::getSid

(

)

Definition at line 96 of file class.ilBaseAuthentication.php.

References $sid.

Referenced by logout(), start(), ilSoapAuthentication\validateSession(), and validateSession().

        {
                return $this->sid;
        }

Here is the caller graph for this function:

getUsername()

ilBaseAuthentication::getUsername

(

)

Definition at line 78 of file class.ilBaseAuthentication.php.

References $username.

Referenced by ilSoapAuthentication\__checkAgreement(), ilSoapAuthentication\authenticate(), and authenticate().

        {
                return $this->username;
        }

Here is the caller graph for this function:

logout()

ilBaseAuthentication::logout

(

)

Definition at line 212 of file class.ilBaseAuthentication.php.

References __setMessage(), getClient(), and getSid().

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

        }

Here is the call graph for this function:

setClient()

ilBaseAuthentication::setClient

(

$a_client

)

Definition at line 64 of file class.ilBaseAuthentication.php.

References $_COOKIE.

        {
                $this->client = $a_client;
                $_COOKIE['ilClientId'] = $a_client;
        }

setPassword()

ilBaseAuthentication::setPassword

(

$a_password

)

Definition at line 82 of file class.ilBaseAuthentication.php.

References $_POST.

        {
                $this->password = $a_password;
                $_POST['password'] = $a_password;
        }

setPasswordType()

ilBaseAuthentication::setPasswordType

(

$a_type

)

Definition at line 118 of file class.ilBaseAuthentication.php.

References $a_type.

        {
                $this->password_type = $a_type;
        }

setSid()

ilBaseAuthentication::setSid

(

$a_sid

)

Definition at line 91 of file class.ilBaseAuthentication.php.

References $_COOKIE, and $sid.

Referenced by ilSoapAuthentication\authenticate(), and authenticate().

        {
                $this->sid = $a_sid;
                $_COOKIE['PHPSESSID'] = $this->sid;
        }

Here is the caller graph for this function:

setUsername()

ilBaseAuthentication::setUsername

(

$a_username

)

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

References $_POST.

        {
                $this->username = $a_username;
                $_POST['username'] = $a_username;
        }

start()

ilBaseAuthentication::start

(

)

Definition at line 166 of file class.ilBaseAuthentication.php.

References __setMessage(), and getSid().

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

                $this->auth->start();

                return true;
        }

Here is the call graph for this function:

validateSession()

ilBaseAuthentication::validateSession

(

)

Definition at line 179 of file class.ilBaseAuthentication.php.

References __buildAuth(), __setMessage(), __setSessionSaveHandler(), getClient(), and getSid().

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

Here is the call graph for this function:

Field Documentation

$auth

ilBaseAuthentication::$auth = null

Definition at line 26 of file class.ilBaseAuthentication.php.

$client

ilBaseAuthentication::$client = ''

Definition at line 53 of file class.ilBaseAuthentication.php.

Referenced by getClient().

$password

ilBaseAuthentication::$password = ''

Definition at line 46 of file class.ilBaseAuthentication.php.

Referenced by getPassword().

$sid

ilBaseAuthentication::$sid = ''

Definition at line 34 of file class.ilBaseAuthentication.php.

Referenced by getSid(), and setSid().

$username

ilBaseAuthentication::$username = ''

Definition at line 40 of file class.ilBaseAuthentication.php.

Referenced by getUsername().

---

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

• Services/Authentication/classes/class.ilBaseAuthentication.php