CAS Basic client features (CAS 1.0, Service Tickets)

Collaboration diagram for CAS Basic client features (CAS 1.0, Service Tickets):

Functions
	CAS_Client::getTicket ()
	This method returns the Service Ticket provided in the URL of the request. More...
	CAS_Client::setTicket ($st)
	This method stores the Service Ticket. More...
	CAS_Client::hasTicket ()
	This method tells if a Service Ticket was stored. More...
	CAS_Client::setCasServerCACert ($cert, $validate_cn)
	Set the CA certificate of the CAS server. More...
	CAS_Client::setNoCasServerValidation ()
	Set no SSL validation for the CAS server. More...
	CAS_Client::validateCAS10 (&$validate_url, &$text_response, &$tree_response, $renew=false)
	This method is used to validate a CAS 1,0 ticket; halt on failure, and sets $validate_url, $text_reponse and $tree_response on success. More...

Variables
	CAS_Client::$_ticket
	The Ticket provided in the URL of the request if present (empty otherwise). More...
	CAS_Client::$_cas_server_ca_cert
	the certificate of the CAS server CA. More...
	CAS_Client::$_cas_server_cn_validate
	validate CN of the CAS server certificate More...
	CAS_Client::$_no_cas_server_validation
	Set to true not to validate the CAS server. More...

Detailed Description

Function Documentation

getTicket()

CAS_Client::getTicket

(

)

This method returns the Service Ticket provided in the URL of the request.

Returns

string service ticket.

Definition at line 1870 of file Client.php.

References CAS_Client\$_ticket.

Referenced by CAS_Client\_buildSAMLPayload(), CAS_Client\isAuthenticated(), CAS_Client\validateCAS10(), CAS_Client\validateCAS20(), and CAS_Client\validateSA().

    {
        return $this->_ticket;
    }

Here is the caller graph for this function:

hasTicket()

CAS_Client::hasTicket

(

)

This method tells if a Service Ticket was stored.

Returns

bool if a Service Ticket has been stored.

Definition at line 1892 of file Client.php.

Referenced by CAS_Client\isAuthenticated().

    {
        return !empty($this->_ticket);
    }

Here is the caller graph for this function:

setCasServerCACert()

CAS_Client::setCasServerCACert	(		$cert,
			$validate_cn
	)

Set the CA certificate of the CAS server.

Parameters

string	$cert	the PEM certificate file name of the CA that emited the cert of the server
bool	$validate_cn	valiate CN of the CAS server certificate

Returns

void

Definition at line 1944 of file Client.php.

    {
    // Argument validation
        if (gettype($cert) != 'string') {
            throw new CAS_TypeMismatchException($cert, '$cert', 'string');
        }
        if (gettype($validate_cn) != 'boolean') {
            throw new CAS_TypeMismatchException($validate_cn, '$validate_cn', 'boolean');
        }
        if ( !file_exists($cert) && $this->_requestImplementation !== 'CAS_TestHarness_DummyRequest'){
            throw new CAS_InvalidArgumentException("Certificate file does not exist " . $this->_requestImplementation);
        }
        $this->_cas_server_ca_cert = $cert;
        $this->_cas_server_cn_validate = $validate_cn;
    }

setNoCasServerValidation()

CAS_Client::setNoCasServerValidation

(

)

Set no SSL validation for the CAS server.

Returns

void

Definition at line 1965 of file Client.php.

    {
        $this->_no_cas_server_validation = true;
    }

setTicket()

CAS_Client::setTicket

(

$st

)

This method stores the Service Ticket.

Parameters

string

$st

The Service Ticket.

Returns

void

Definition at line 1882 of file Client.php.

Referenced by CAS_Client\_wasPreviouslyAuthenticated().

    {
        $this->_ticket = $st;
    }

Here is the caller graph for this function:

validateCAS10()

CAS_Client::validateCAS10	(	&	$validate_url,
		&	$text_response,
		&	$tree_response,
			$renew = false
	)

This method is used to validate a CAS 1,0 ticket; halt on failure, and sets $validate_url, $text_reponse and $tree_response on success.

Parameters

string	&$validate_url	reference to the the URL of the request to the CAS server.
string	&$text_response	reference to the response of the CAS server, as is (XML text).
string	&$tree_response	reference to the response of the CAS server, as a DOM XML tree.
bool	$renew	true to force the authentication with the CAS server

Returns

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

Definition at line 1985 of file Client.php.

References $result, CAS_Client\_readURL(), CAS_Client\getServerServiceValidateURL(), CAS_Client\getTicket(), n, to, phpCAS\trace(), and phpCAS\traceBegin().

    {
        phpCAS::traceBegin();
        $result = false;
        // build the URL to validate the ticket
        $validate_url = $this->getServerServiceValidateURL()
            .'&ticket='.urlencode($this->getTicket());

        if ( $renew ) {
            // pass the renew
            $validate_url .= '&renew=true';
        }

        // open and read the URL
        if ( !$this->_readURL($validate_url, $headers, $text_response, $err_msg) ) {
            phpCAS::trace(
                'could not open URL \''.$validate_url.'\' to validate ('.$err_msg.')'
            );
            throw new CAS_AuthenticationException(
                $this, 'CAS 1.0 ticket not validated', $validate_url,
                true/*$no_response*/
            );
            $result = false;
        }

        if (preg_match('/^no\n/', $text_response)) {
            phpCAS::trace('Ticket has not been validated');
            throw new CAS_AuthenticationException(
                $this, 'ST not validated', $validate_url, false/*$no_response*/,
                false/*$bad_response*/, $text_response
            );
            $result = false;
        } else if (!preg_match('/^yes\n/', $text_response)) {
            phpCAS::trace('ill-formed response');
            throw new CAS_AuthenticationException(
                $this, 'Ticket not validated', $validate_url,
                false/*$no_response*/, true/*$bad_response*/, $text_response
            );
            $result = false;
        }
        // ticket has been validated, extract the user name
        $arr = preg_split('/\n/', $text_response);
        $this->_setUser(trim($arr[1]));
        $result = true;

        if ($result) {
            $this->_renameSession($this->getTicket());
        }
        // at this step, ticket has been validated and $this->_user has been set,
        phpCAS::traceEnd(true);
        return true;
    }

Here is the call graph for this function:

Variable Documentation

$_cas_server_ca_cert

CAS_Client::$_cas_server_ca_cert

private

the certificate of the CAS server CA.

Definition at line 1912 of file Client.php.

$_cas_server_cn_validate

CAS_Client::$_cas_server_cn_validate

private

validate CN of the CAS server certificate

Definition at line 1925 of file Client.php.

$_no_cas_server_validation

CAS_Client::$_no_cas_server_validation

private

Set to true not to validate the CAS server.

Definition at line 1932 of file Client.php.

$_ticket

CAS_Client::$_ticket

private

The Ticket provided in the URL of the request if present (empty otherwise).

Written by CAS_Client::CAS_Client(), read by CAS_Client::getTicket() and CAS_Client::_hasPGT().

Definition at line 1863 of file Client.php.

Referenced by CAS_Client\getTicket().