ilSOAPAuth Class Reference

Class SOAPAuth. More...

Inheritance diagram for ilSOAPAuth:

Collaboration diagram for ilSOAPAuth:

Static Public Member Functions
static	testConnection ($a_ext_uid, $a_soap_pw, $a_new_user)
	Constructor public.
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
	$valid = array()
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

Additional Inherited Members
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.
	assignData ()
	Assign data from login form to internal values.
	start ()
	Start new auth session.
	login ()
	Login function.
	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?
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
	$exceeded_user_name

Detailed Description

Class SOAPAuth.

SOAP Authentication class.

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

Member Function Documentation

static ilSOAPAuth::testConnection (   $a_ext_uid,   $a_soap_pw,   $a_new_user  )

static

Constructor public.

Test connection with values of soap auth administration settings

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

References $ilSetting, $namespace, and $valid.

        {
                global $ilSetting;
                
                $settings = $ilSetting->getAll();
                
                $server_hostname = $settings["soap_auth_server"];
                $server_port = (int) $settings["soap_auth_port"];
                $server_uri = $settings["soap_auth_uri"];
                $namespace = $settings["soap_auth_namespace"];
                $use_dotnet = $settings["soap_auth_use_dotnet"];
                if ($settings["soap_auth_use_https"])
                {
                        $uri = "https://";
                }
                else
                {
                        $uri = "http://";
                }
                
                $uri.= $server_hostname;
                
                if ($server_port > 0)
                {
                        $uri.= ":".$server_port;
                }

                if ($server_uri != "")
                {
                        $uri.= "/".$server_uri;
                }

                $soap_client = new nusoap_client($uri);
                if ($err = $soap_client->getError()) 
                {
                        return "SOAP Authentication Initialisation Error: ".$err;
                }
                
                $soapAction = "";
                $nspref = "";
                if ($use_dotnet)
                {
                        $soapAction = $namespace."/isValidSession";
                        $nspref = "ns1:";
                }
                
                $valid = $soap_client->call('isValidSession',
                        array($nspref.'ext_uid' => $a_ext_uid,
                                $nspref.'soap_pw' => $a_soap_pw,
                                $nspref.'new_user' => $a_new_user),
                        $namespace,
                        $soapAction);
                        
                return
                        "<br>== Request ==".
                        '<br><pre>' . htmlspecialchars(str_replace("\" ", "\"\n ", str_replace(">", ">\n", $soap_client->request)), ENT_QUOTES) . '</pre><br>'.
                        "<br>== Response ==".
                        "<br>Valid: -".$valid["valid"]."-".
                        '<br><pre>' . htmlspecialchars(str_replace("\" ", "\"\n ", str_replace(">", ">\n", $soap_client->response)), ENT_QUOTES) . '</pre>';
        }

Field Documentation

ilSOAPAuth::$valid = array()

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

Referenced by testConnection().

---

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

• Services/SOAPAuth/classes/class.ilSOAPAuth.php