ilAuthOpenId Class Reference

Open ID auth class More...

Inheritance diagram for ilAuthOpenId:

Collaboration diagram for ilAuthOpenId:

Public Member Functions
	__construct ($a_container, $a_addition_options=array())
	Contructor. More...
	supportsRedirects ()
	Returns true, if the current auth mode allows redirection to e.g to loginScreen, public section... More...
	callProvider ($username, $status, $auth)
	Auth login function Redirects to openid provider. 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 ()

Protected Member Functions
	initSettings ()
	Init open id settings. More...
	parseUsername (&$username, $auth)
	Parse username. More...
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...

Private Attributes
	$settings = null

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 Attributes inherited from ilAuthBase
	$sub_status = null
	$exceeded_user_name

Detailed Description

Open ID auth class

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

Definition at line 11 of file class.ilAuthOpenId.php.

Constructor & Destructor Documentation

__construct()

ilAuthOpenId::__construct	(		$a_container,
			$a_addition_options = array()
	)

Contructor.

Returns

Parameters

object	$a_container
object	$a_addition_options,[optional]

Definition at line 21 of file class.ilAuthOpenId.php.

References $_GET, $_POST, ilAuthBase\initAuth(), initSettings(), and Auth\setSessionName().

        {
                parent::__construct(
                        $a_container,
                        $a_addition_options,
                        array($this,'callProvider'),
                        true);
                $this->setSessionName("_authhttp".md5(CLIENT_ID));
                
                $this->initAuth();
                $this->initSettings();
                
                if(isset($_GET['oid_check_status']))
                {
                        $_POST['username'] = 'dummy';
                        $_POST['password'] = 'dummy';
                }
                
        }

Here is the call graph for this function:

Member Function Documentation

callProvider()

ilAuthOpenId::callProvider	(		$username,
			$status,
			$auth
	)

Auth login function Redirects to openid provider.

Parameters

object	$username
object	$status
object	$auth

Returns

Definition at line 62 of file class.ilAuthOpenId.php.

References $_POST, $auth, $ilCtrl, Auth\$username, AUTH_WRONG_LOGIN, Auth_OpenID_SRegRequest\build(), parseUsername(), and ilUtil\redirect().

        {
                global $ilCtrl;
                
                $username = $_POST['oid_username'];
                
                if(!$this->parseUsername($username,$auth))
                {
                        return false;
                }
                
                $consumer = $this->settings->getConsumer();
                $oid_auth = $consumer->begin($username);
                
                if (!$oid_auth) 
                {
                $auth->status = AUTH_WRONG_LOGIN;
                        return false;
                }

                include_once 'Auth/OpenID/SReg.php';
            $sreg_req = Auth_OpenID_SRegRequest::build(
                        // Required
                        array('nickname'),
                        // Optional
                        array(
                                'fullname',
                                'dob',
                                'email',
                                'gender',
                                'postcode',
                                'language',
                                'timezone'
                        )
                );

                if ($sreg_req)
                {
                        $oid_auth->addExtension($sreg_req);
                }

                // TODO: Switch openid v. 1,2
                $url = $oid_auth->redirectURL(ILIAS_HTTP_PATH,$this->settings->getReturnLocation());
                ilUtil::redirect($url);
        }

Here is the call graph for this function:

initSettings()

ilAuthOpenId::initSettings ( )

protected

Init open id settings.

Returns

Definition at line 112 of file class.ilAuthOpenId.php.

References ilOpenIdSettings\getInstance().

Referenced by __construct().

        {
                include_once './Services/OpenId/classes/class.ilOpenIdSettings.php';
                $this->settings = ilOpenIdSettings::getInstance();
                $this->settings->initConsumer();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

parseUsername()

ilAuthOpenId::parseUsername ( &  $username,   $auth  )

protected

Parse username.

Returns

Definition at line 123 of file class.ilAuthOpenId.php.

References $_POST, $auth, $GLOBALS, Auth\$username, AUTH_WRONG_LOGIN, and ilOpenIdProviders\getInstance().

Referenced by callProvider().

        {
                if($_POST['oid_provider'])
                {
                        include_once './Services/OpenId/classes/class.ilOpenIdProviders.php';
                        try 
                        {
                                $url = ilOpenIdProviders::getInstance()->getProviderById($_POST['oid_provider'])->getURL();
                                $username = sprintf($url,(string) $username);
                                $GLOBALS['ilLog']->write(__METHOD__.': Using '.$username.' for authentication');
                                return true;
                        }
                        catch(UnexpectedValueException $e)
                        {
                                $GLOBALS['ilLog']->write(__METHOD__.': Unknown provider id given: '.$username);
                                $auth->status = AUTH_WRONG_LOGIN;
                                return false;
                        }
                }
                if($this->settings->forcedProviderSelection())
                {
                        $auth->status = AUTH_WRONG_LOGIN;
                        return false;
                }
                $GLOBALS['ilLog']->write(__METHOD__.': Trying openid url: '.$username);
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

supportsRedirects()

ilAuthOpenId::supportsRedirects

(

)

Returns true, if the current auth mode allows redirection to e.g to loginScreen, public section...

Todo:

check if redirects are possible

Returns

Definition at line 49 of file class.ilAuthOpenId.php.

        {
                return true;
        }

Field Documentation

$settings

ilAuthOpenId::$settings = null

private

Definition at line 13 of file class.ilAuthOpenId.php.

---

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

• Services/OpenId/classes/class.ilAuthOpenId.php