PGT storage

Collaboration diagram for PGT storage:

Modules
	PGT storage in a database
	PGT storage on the filesystem

Namespaces
	PhpCAS

Functions
	CAS_Client::_initPGTStorage ()
	This method is used to initialize the storage of PGT's. More...
	CAS_Client::_storePGT ($pgt, $pgt_iou)
	This method stores a PGT. More...
	CAS_Client::_loadPGT ($pgt_iou)
	This method reads a PGT from its Iou and deletes the corresponding storage entry. More...
	CAS_Client::setPGTStorage ($storage)
	This method can be used to set a custom PGT storage object. More...
	CAS_Client::setPGTStorageDb ( $dsn_or_pdo, $username='', $password='', $table='', $driver_options=null)
	This method is used to tell phpCAS to store the response of the CAS server to PGT requests in a database. More...
	CAS_Client::setPGTStorageFile ($path='')
	This method is used to tell phpCAS to store the response of the CAS server to PGT requests onto the filesystem. More...
	CAS_Client::_validatePGT (&$validate_url, $text_response, $tree_response)
	This method is used to validate a PGT; halt on failure. More...
	CAS_Client::retrievePT ($target_service, &$err_code, &$err_msg)
	This method is used to retrieve PT's from the CAS server thanks to a PGT. More...
	CAS_PGTStorage_AbstractStorage::__construct ($cas_parent)
	The constructor of the class, should be called only by inherited classes. More...
	CAS_PGTStorage_AbstractStorage::getStorageType ()
	This virtual method returns an informational string giving the type of storage used by the object (used for debugging purposes). More...
	CAS_PGTStorage_AbstractStorage::getStorageInfo ()
	This virtual method returns an informational string giving informations on the parameters of the storage. More...
	CAS_PGTStorage_AbstractStorage::setErrorMessage ($error_message)
	This method sets en error message, which can be read later by PGTStorage::getErrorMessage(). More...
	CAS_PGTStorage_AbstractStorage::getErrorMessage ()
	This method returns an error message set by PGTStorage::setErrorMessage(). More...
	CAS_PGTStorage_AbstractStorage::isInitialized ()
	This method tells if the storage has already been intialized. More...
	CAS_PGTStorage_AbstractStorage::init ()
	This virtual method initializes the object. More...
	CAS_PGTStorage_AbstractStorage::write ($pgt, $pgt_iou)
	This virtual method stores a PGT and its corresponding PGT Iuo. More...
	CAS_PGTStorage_AbstractStorage::read ($pgt_iou)
	This virtual method reads a PGT corresponding to a PGT Iou and deletes the corresponding storage entry. More...

Variables
	CAS_Client::$_pgt_storage
	an instance of a class inheriting of PGTStorage, used to deal with PGT storage. More...
	CAS_PGTStorage_AbstractStorage::$_error_message
	string used to store an error message. More...
	CAS_PGTStorage_AbstractStorage::$_initialized
	a boolean telling if the storage has already been initialized. More...

Detailed Description

Function Documentation

__construct()

CAS_PGTStorage_AbstractStorage::__construct

(

$cas_parent

)

The constructor of the class, should be called only by inherited classes.

Parameters

CAS_Client

$cas_parent

the CAS _client instance that creates the current object.

Returns

void

Definition at line 67 of file AbstractStorage.php.

References phpCAS\error(), phpCAS\traceBegin(), and phpCAS\traceEnd().

    {
        phpCAS::traceBegin();
        if (!$cas_parent->isProxy()) {
            phpCAS::error(
                'defining PGT storage makes no sense when not using a CAS proxy'
            );
        }
        phpCAS::traceEnd();
    }

Here is the call graph for this function:

_initPGTStorage()

CAS_Client::_initPGTStorage ( )

private

This method is used to initialize the storage of PGT's.

Halts on error.

Returns

void

Definition at line 2516 of file Client.php.

References CAS_Client\setPGTStorageFile().

Referenced by CAS_Client\_loadPGT(), and CAS_Client\_storePGT().

    {
        // if no SetPGTStorageXxx() has been used, default to file
        if (!is_object($this->_pgt_storage)) {
            $this->setPGTStorageFile();
        }

        // initializes the storage
        $this->_pgt_storage->init();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_loadPGT()

CAS_Client::_loadPGT (   $pgt_iou )

private

This method reads a PGT from its Iou and deletes the corresponding storage entry.

Parameters

string

$pgt_iou

the PGT Iou

Returns

mul The PGT corresponding to the Iou, false when not found.

Definition at line 2551 of file Client.php.

References CAS_Client\_initPGTStorage().

Referenced by CAS_Client\_validatePGT().

    {
        // ensure that storage is initialized
        $this->_initPGTStorage();
        // read the PGT
        return $this->_pgt_storage->read($pgt_iou);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_storePGT()

CAS_Client::_storePGT (   $pgt,   $pgt_iou  )

private

This method stores a PGT.

Halts on error.

Parameters

string	$pgt	the PGT to store
string	$pgt_iou	its corresponding Iou

Returns

void

Definition at line 2535 of file Client.php.

References CAS_Client\_initPGTStorage().

Referenced by CAS_Client\_callback().

    {
        // ensure that storage is initialized
        $this->_initPGTStorage();
        // writes the PGT
        $this->_pgt_storage->write($pgt, $pgt_iou);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_validatePGT()

CAS_Client::_validatePGT ( &  $validate_url,   $text_response,   $tree_response  )

private

This method is used to validate a PGT; halt on failure.

Parameters

string	&$validate_url	the URL of the request to the CAS server.
string	$text_response	the response of the CAS server, as is (XML text); result of CAS_Client::validateCAS10() or CAS_Client::validateCAS20().
string	$tree_response	the response of the CAS server, as a DOM XML tree; result of CAS_Client::validateCAS10() or CAS_Client::validateCAS20().

Returns

bool true when successfull and issue a CAS_AuthenticationException and false on an error

Definition at line 2680 of file Client.php.

References CAS_Client\_loadPGT(), CAS_Client\_setPGT(), phpCAS\trace(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Referenced by CAS_Client\isAuthenticated().

    {
        phpCAS::traceBegin();
        if ($tree_response->getElementsByTagName("proxyGrantingTicket")->length == 0) {
            phpCAS::trace('<proxyGrantingTicket> not found');
            // authentication succeded, but no PGT Iou was transmitted
            throw new CAS_AuthenticationException(
                $this,
                'Ticket validated but no PGT Iou transmitted',
                $validate_url,
                false/*$no_response*/,
                false/*$bad_response*/,
                $text_response
            );
        } else {
            // PGT Iou transmitted, extract it
            $pgt_iou = trim(
                $tree_response->getElementsByTagName("proxyGrantingTicket")->item(0)->nodeValue
            );
            if (preg_match('/PGTIOU-[\.\-\w]/', $pgt_iou)) {
                $pgt = $this->_loadPGT($pgt_iou);
                if ($pgt == false) {
                    phpCAS::trace('could not load PGT');
                    throw new CAS_AuthenticationException(
                        $this,
                        'PGT Iou was transmitted but PGT could not be retrieved',
                        $validate_url,
                        false/*$no_response*/,
                        false/*$bad_response*/,
                        $text_response
                    );
                }
                $this->_setPGT($pgt);
            } else {
                phpCAS::trace('PGTiou format error');
                throw new CAS_AuthenticationException(
                    $this,
                    'PGT Iou was transmitted but has wrong format',
                    $validate_url,
                    false/*$no_response*/,
                    false/*$bad_response*/,
                    $text_response
                );
            }
        }
        phpCAS::traceEnd(true);
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getErrorMessage()

CAS_PGTStorage_AbstractStorage::getErrorMessage

(

)

This method returns an error message set by PGTStorage::setErrorMessage().

Returns

an error message when set by PGTStorage::setErrorMessage(), FALSE otherwise.

Deprecated:

not used.

Definition at line 144 of file AbstractStorage.php.

References CAS_PGTStorage_AbstractStorage\$_error_message.

    {
        return $this->_error_message;
    }

getStorageInfo()

CAS_PGTStorage_AbstractStorage::getStorageInfo

(

)

This virtual method returns an informational string giving informations on the parameters of the storage.

(used for debugging purposes).

Returns

void

Definition at line 103 of file AbstractStorage.php.

References phpCAS\error().

    {
        phpCAS::error(__CLASS__ . '::' . __FUNCTION__ . '() should never be called');
    }

Here is the call graph for this function:

getStorageType()

CAS_PGTStorage_AbstractStorage::getStorageType

(

)

This virtual method returns an informational string giving the type of storage used by the object (used for debugging purposes).

Returns

void

Definition at line 90 of file AbstractStorage.php.

References phpCAS\error().

    {
        phpCAS::error(__CLASS__ . '::' . __FUNCTION__ . '() should never be called');
    }

Here is the call graph for this function:

init()

CAS_PGTStorage_AbstractStorage::init

(

)

This virtual method initializes the object.

Returns

void

Definition at line 178 of file AbstractStorage.php.

    {
        $this->_initialized = true;
    }

isInitialized()

CAS_PGTStorage_AbstractStorage::isInitialized

(

)

This method tells if the storage has already been intialized.

Returns

a boolean

Definition at line 168 of file AbstractStorage.php.

References CAS_PGTStorage_AbstractStorage\$_initialized.

Referenced by CAS_PGTStorage_Db\createTable(), CAS_PGTStorage_File\init(), and CAS_PGTStorage_Db\init().

    {
        return $this->_initialized;
    }

Here is the caller graph for this function:

read()

CAS_PGTStorage_AbstractStorage::read

(

$pgt_iou

)

This virtual method reads a PGT corresponding to a PGT Iou and deletes the corresponding storage entry.

Parameters

string

$pgt_iou

the PGT iou

Returns

void

Note

Should never be called.

Definition at line 213 of file AbstractStorage.php.

References phpCAS\error().

    {
        phpCAS::error(__CLASS__ . '::' . __FUNCTION__ . '() should never be called');
    }

Here is the call graph for this function:

retrievePT()

CAS_Client::retrievePT	(		$target_service,
		&	$err_code,
		&	$err_msg
	)

This method is used to retrieve PT's from the CAS server thanks to a PGT.

Parameters

string	$target_service	the service to ask for with the PT.
string	&$err_code	an error code (PHPCAS_SERVICE_OK on success).
string	&$err_msg	an error message (empty on success).

Returns

a Proxy Ticket, or false on error.

Definition at line 2742 of file Client.php.

References CAS_Client\_getPGT(), CAS_Client\_readURL(), CAS_Client\getServerProxyURL(), phpCAS\trace(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Referenced by CAS_Client\initializeProxiedService().

    {
        // Argument validation
        if (gettype($target_service) != 'string') {
            throw new CAS_TypeMismatchException($target_service, '$target_service', 'string');
        }

        phpCAS::traceBegin();

        // by default, $err_msg is set empty and $pt to true. On error, $pt is
        // set to false and $err_msg to an error message. At the end, if $pt is false
        // and $error_msg is still empty, it is set to 'invalid response' (the most
        // commonly encountered error).
        $err_msg = '';

        // build the URL to retrieve the PT
        $cas_url = $this->getServerProxyURL() . '?targetService='
            . urlencode($target_service) . '&pgt=' . $this->_getPGT();

        // open and read the URL
        if (!$this->_readURL($cas_url, $headers, $cas_response, $err_msg)) {
            phpCAS::trace(
                'could not open URL \'' . $cas_url . '\' to validate (' . $err_msg . ')'
            );
            $err_code = PHPCAS_SERVICE_PT_NO_SERVER_RESPONSE;
            $err_msg = 'could not retrieve PT (no response from the CAS server)';
            phpCAS::traceEnd(false);
            return false;
        }

        $bad_response = false;

        if (!$bad_response) {
            // create new DOMDocument object
            $dom = new DOMDocument();
            // Fix possible whitspace problems
            $dom->preserveWhiteSpace = false;
            // read the response of the CAS server into a DOM object
            if (!($dom->loadXML($cas_response))) {
                phpCAS::trace('dom->loadXML() failed');
                // read failed
                $bad_response = true;
            }
        }

        if (!$bad_response) {
            // read the root node of the XML tree
            if (!($root = $dom->documentElement)) {
                phpCAS::trace('documentElement failed');
                // read failed
                $bad_response = true;
            }
        }

        if (!$bad_response) {
            // insure that tag name is 'serviceResponse'
            if ($root->localName != 'serviceResponse') {
                phpCAS::trace('localName failed');
                // bad root node
                $bad_response = true;
            }
        }

        if (!$bad_response) {
            // look for a proxySuccess tag
            if ($root->getElementsByTagName("proxySuccess")->length != 0) {
                $proxy_success_list = $root->getElementsByTagName("proxySuccess");

                // authentication succeded, look for a proxyTicket tag
                if ($proxy_success_list->item(0)->getElementsByTagName("proxyTicket")->length != 0) {
                    $err_code = PHPCAS_SERVICE_OK;
                    $err_msg = '';
                    $pt = trim(
                        $proxy_success_list->item(0)->getElementsByTagName("proxyTicket")->item(0)->nodeValue
                    );
                    phpCAS::trace('original PT: ' . trim($pt));
                    phpCAS::traceEnd($pt);
                    return $pt;
                } else {
                    phpCAS::trace('<proxySuccess> was found, but not <proxyTicket>');
                }
            } elseif ($root->getElementsByTagName("proxyFailure")->length != 0) {
                // look for a proxyFailure tag
                $proxy_failure_list = $root->getElementsByTagName("proxyFailure");

                // authentication failed, extract the error
                $err_code = PHPCAS_SERVICE_PT_FAILURE;
                $err_msg = 'PT retrieving failed (code=`'
                . $proxy_failure_list->item(0)->getAttribute('code')
                . '\', message=`'
                . trim($proxy_failure_list->item(0)->nodeValue)
                . '\')';
                phpCAS::traceEnd(false);
                return false;
            } else {
                phpCAS::trace('neither <proxySuccess> nor <proxyFailure> found');
            }
        }

        // at this step, we are sure that the response of the CAS server was
        // illformed
        $err_code = PHPCAS_SERVICE_PT_BAD_SERVER_RESPONSE;
        $err_msg = 'Invalid response from the CAS server (response=`'
            . $cas_response . '\')';

        phpCAS::traceEnd(false);
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setErrorMessage()

CAS_PGTStorage_AbstractStorage::setErrorMessage

(

$error_message

)

This method sets en error message, which can be read later by PGTStorage::getErrorMessage().

Parameters

string

$error_message

an error message

Returns

void

Deprecated:

not used.

Definition at line 131 of file AbstractStorage.php.

    {
        $this->_error_message = $error_message;
    }

setPGTStorage()

CAS_Client::setPGTStorage

(

$storage

)

This method can be used to set a custom PGT storage object.

Parameters

CAS_PGTStorage_AbstractStorage

$storage

a PGT storage object that inherits from the CAS_PGTStorage_AbstractStorage class

Returns

void

Definition at line 2567 of file Client.php.

References CAS_Client\ensureIsProxy(), and phpCAS\error().

Referenced by CAS_Client\setPGTStorageDb(), and CAS_Client\setPGTStorageFile().

    {
        // Sequence validation
        $this->ensureIsProxy();

        // check that the storage has not already been set
        if (is_object($this->_pgt_storage)) {
            phpCAS::error('PGT storage already defined');
        }

        // check to make sure a valid storage object was specified
        if (!($storage instanceof CAS_PGTStorage_AbstractStorage)) {
            throw new CAS_TypeMismatchException($storage, '$storage', 'CAS_PGTStorage_AbstractStorage object');
        }

        // store the PGTStorage object
        $this->_pgt_storage = $storage;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setPGTStorageDb()

CAS_Client::setPGTStorageDb	(		$dsn_or_pdo,
			$username = '',
			$password = '',
			$table = '',
			$driver_options = null
	)

This method is used to tell phpCAS to store the response of the CAS server to PGT requests in a database.

Parameters

string	$dsn_or_pdo	a dsn string to use for creating a PDO object or a PDO object
string	$username	the username to use when connecting to the database
string	$password	the password to use when connecting to the database
string	$table	the table to use for storing and retrieving PGTs
string	$driver_options	any driver options to use when connecting to the database

Returns

void

Definition at line 2603 of file Client.php.

References $password, $table, CAS_Client\ensureIsProxy(), and CAS_Client\setPGTStorage().

      {
        // Sequence validation
        $this->ensureIsProxy();

        // Argument validation
        if ((is_object($dsn_or_pdo) && !($dsn_or_pdo instanceof PDO)) || gettype($dsn_or_pdo) != 'string') {
            throw new CAS_TypeMismatchException($dsn_or_pdo, '$dsn_or_pdo', 'string or PDO object');
        }
        if (gettype($username) != 'string') {
            throw new CAS_TypeMismatchException($username, '$username', 'string');
        }
        if (gettype($password) != 'string') {
            throw new CAS_TypeMismatchException($password, '$password', 'string');
        }
        if (gettype($table) != 'string') {
            throw new CAS_TypeMismatchException($table, '$password', 'string');
        }

        // create the storage object
        $this->setPGTStorage(
            new CAS_PGTStorage_Db(
                $this,
                $dsn_or_pdo,
                $username,
                $password,
                $table,
                $driver_options
            )
        );
    }

Here is the call graph for this function:

setPGTStorageFile()

CAS_Client::setPGTStorageFile

(

$path = ''

)

This method is used to tell phpCAS to store the response of the CAS server to PGT requests onto the filesystem.

Parameters

string

$path

the path where the PGT's should be stored

Returns

void

Definition at line 2648 of file Client.php.

References $path, CAS_Client\ensureIsProxy(), and CAS_Client\setPGTStorage().

Referenced by CAS_Client\_initPGTStorage().

    {
        // Sequence validation
        $this->ensureIsProxy();

        // Argument validation
        if (gettype($path) != 'string') {
            throw new CAS_TypeMismatchException($path, '$path', 'string');
        }

        // create the storage object
        $this->setPGTStorage(new CAS_PGTStorage_File($this, $path));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

write()

CAS_PGTStorage_AbstractStorage::write	(		$pgt,
			$pgt_iou
	)

This virtual method stores a PGT and its corresponding PGT Iuo.

Parameters

string	$pgt	the PGT
string	$pgt_iou	the PGT iou

Returns

void

Note

Should never be called.

Definition at line 198 of file AbstractStorage.php.

References phpCAS\error().

    {
        phpCAS::error(__CLASS__ . '::' . __FUNCTION__ . '() should never be called');
    }

Here is the call graph for this function:

Variable Documentation

$_error_message

CAS_PGTStorage_AbstractStorage::$_error_message

string used to store an error message.

Written by PGTStorage::setErrorMessage(), read by PGTStorage::getErrorMessage().

Deprecated:

not used.

Definition at line 119 of file AbstractStorage.php.

Referenced by CAS_PGTStorage_AbstractStorage\getErrorMessage().

$_initialized

CAS_PGTStorage_AbstractStorage::$_initialized

a boolean telling if the storage has already been initialized.

Written by PGTStorage::init(), read by PGTStorage::isInitialized().

Definition at line 159 of file AbstractStorage.php.

Referenced by CAS_PGTStorage_AbstractStorage\isInitialized().

$_pgt_storage

CAS_Client::$_pgt_storage

private

an instance of a class inheriting of PGTStorage, used to deal with PGT storage.

Created by CAS_Client::setPGTStorageFile(), used by CAS_Client::setPGTStorageFile() and CAS_Client::_initPGTStorage().

Definition at line 2508 of file Client.php.