ilAuthHTTP Class Reference

Base class for ilAuth, ilAuthHTTP .... More...

Inheritance diagram for ilAuthHTTP:

Collaboration diagram for ilAuthHTTP:

Public Member Functions
	supportsRedirects ()
	Returns true, if the current auth mode allows redirection to e.g to loginScreen, public section...
	__construct ($container, $a_options=array())
	Constructor.
Public Member Functions inherited from Auth_HTTP
	Auth_HTTP ($storageDriver, $options= '')
	Constructor.
	assignData ()
	Assign values from $PHP_AUTH_USER and $PHP_AUTH_PW or 'Authorization' header to internal variables and sets the session id based on them.
	login ()
	Login function.
	drawLogin ($username="")
	Launch the login box.
	setRealm ($realm, $digestRealm= '')
	Set name of the current realm.
	setCancelText ($text)
	Set the text to send if user hits the cancel button.
	validateDigest ($response, $a1)
	judge if the client response is valid.
	_judgeStale ($nonce)
	judge if nonce from client is stale.
	_decodeNonce ($nonce, &$time, &$hash)
	decode nonce string
	_getNonce ()
	return nonce to detect timeout
	authenticationInfo ($contentMD5= '')
	output HTTP Authentication-Info header
	setOption ($name, $value=null)
	set authentication option
	getOption ($name)
	get authentication option
	selfURI ()
	get self URI
Public Member Functions inherited from Auth
	Auth ($storageDriver, $options= '', $loginFunction= '', $showLogin=true)
	Constructor.
&	applyAuthOptions (&$options)
	Set the Auth options.
	_loadStorage ()
	Load Storage Driver if not already loaded.
	start ()
	Start new auth session.
	setExpire ($time, $add=false)
	Set the maximum expire time.
	setIdle ($time, $add=false)
	Set the maximum idle time.
	setSessionName ($name= 'session')
	Set name of the session to a customized value.
	setShowLogin ($showLogin=true)
	Should the login form be displayed if neccessary?
	setAllowLogin ($allowLogin=true)
	Should the login form be displayed if neccessary?
	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.
	setLoginCallback ($loginCallback)
	Register a callback function to be called on user login.
	setFailedLoginCallback ($loginFailedCallback)
	Register a callback function to be called on failed user login.
	setLogoutCallback ($logoutCallback)
	Register a callback function to be called on user logout.
	setAuthData ($name, $value, $overwrite=true)
	Register additional information that is to be stored in the session.
	getAuthData ($name=null)
	Get additional information that is stored in the session.
	setAuth ($username)
	Register variable in a session telling that the user has logged in successfully.
	setAdvancedSecurity ($flag=true)
	Enables advanced security checks.
	checkAuth ()
	Checks if there is a session with valid auth information.
	getAuth ()
	Has the user been authenticated?
	logout ()
	Logout function.
	updateIdle ()
	Update the idletime.
	getUsername ()
	Get the username.
	getStatus ()
	Get the current status.
	getPostUsernameField ()
	Gets the post varible used for the username.
	getPostPasswordField ()
	Gets the post varible used for the username.
	sessionValidThru ()
	Returns the time up to the session is valid.
	listUsers ()
	List all users that are currently available in the storage container.
	addUser ($username, $password, $additional= '')
	Add user to the storage container.
	removeUser ($username)
	Remove user from the storage container.
	changePassword ($username, $password)
	Change password for user in the storage container.
	log ($message, $level=AUTH_LOG_DEBUG)
	Log a message from the Auth system.
	_loadLogger ()
	Load Log object if not already loaded.
	attachLogObserver (&$observer)
	Attach an Observer to the Auth Log Source.
	_isAdvancedSecurityEnabled ($feature=null)
	Is advanced security enabled?
Public Member Functions inherited from ilAuthBase
	supportRedirects ()
	Returns true, if the current auth mode allows redirects to e.g the login screen, public section ...
	getContainer ()
	Get container object.

Additional Inherited Members
Static Public Member Functions inherited from Auth
&	_factory ($driver, $options= '')
	Return a storage driver based on $driver and $options.
	staticCheckAuth ($options=null)
	Statically checks if there is a session with valid auth information.
Data Fields inherited from Auth_HTTP
	$authType = 'basic'
	$realm = "protected area"
	$CancelText = "Error 401 - Access denied"
	$options = array()
	$stale = false
	$opaque = 'dummy'
	$uri = ''
	$auth = array()
	$nextNonce = ''
	$nonce = ''
	$server
	$post
	$cookie
Protected Member Functions inherited from ilAuthBase
	initAuth ()
	Init auth object Enable logging, set callbacks...
	loginObserver ($a_username, $a_auth)
	Called after successful login.
	failedLoginObserver ($a_username, $a_auth)
	Called after failed login.
	checkAuthObserver ($a_username, $a_auth)
	Called after each check auth request.
	logoutObserver ($a_username, $a_auth)
	Called after logout.
Protected Attributes inherited from ilAuthBase
	$sub_status = null

Detailed Description

Base class for ilAuth, ilAuthHTTP ....

Author

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

Version

$Id$

Definition at line 36 of file class.ilAuthHTTP.php.

Constructor & Destructor Documentation

ilAuthHTTP::__construct	(		$container,
			$a_options = array()
	)

Constructor.

Parameters

object	Auth_ContainerBase
array	further options Not used in the moment

Reimplemented in ilAuthCalendar.

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

References ilAuthBase\initAuth(), Auth_HTTP\setRealm(), and Auth\setSessionName().

    {
                $a_options['sessionSharing'] = false;

        parent::__construct($container,$a_options);
                $this->setSessionName("_authhttp".md5(CLIENT_ID));
                $this->setRealm(CLIENT_ID);

                $this->initAuth();
    }

Here is the call graph for this function:

Member Function Documentation

ilAuthHTTP::supportsRedirects

(

)

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

Returns

Reimplemented in ilAuthCalendar.

Definition at line 44 of file class.ilAuthHTTP.php.

        {
                return false;
        } 

---

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

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