Miscellaneous

Collaboration diagram for Miscellaneous:

Functions
	CAS_Client::_readURL ($url, &$headers, &$body, &$err_msg)
	This method is used to acces a remote URL. More...
	CAS_Client::_buildSAMLPayload ()
	This method is used to build the SAML POST body sent to /samlValidate URL. More...
	CAS_Client::setURL ($url)
	This method sets the URL of the current request. More...
	CAS_Client::getURL ()
	This method returns the URL of the current request (without any ticket CGI parameter). More...
	CAS_Client::setBaseURL ($url)
	This method sets the base URL of the CAS server. More...
	CAS_Client::_getClientUrl ()
	Try to figure out the phpCas client URL with possible Proxys / Ports etc. More...
	CAS_Client::_isHttps ()
	This method checks to see if the request is secured via HTTPS. More...
	CAS_Client::_removeParameterFromQueryString ($parameterName, $queryString)
	Removes a parameter from a query string. More...
	CAS_Client::_buildQueryUrl ($url, $query)
	This method is used to append query parameters to an url. More...
	CAS_Client::_renameSession ($ticket)
	Renaming the session. More...
	CAS_Client::_authError ( $failure, $cas_url, $no_response, $bad_response='', $cas_response='', $err_code='', $err_msg='')
	This method is used to print the HTML output when the user was not authenticated. More...
	CAS_Client::_getNodeType ($nodeURL)
	Determine the node type from the URL. More...
	CAS_Client::addRebroadcastNode ($rebroadcastNodeUrl)
	Store the rebroadcast node for pgtIou/pgtId and logout requests. More...
	CAS_Client::addRebroadcastHeader ($header)
	This method is used to add header parameters when rebroadcasting pgtIou/pgtId or logoutRequest. More...
	CAS_Client::_rebroadcast ($type)
	This method rebroadcasts logout/pgtIou requests. More...

Variables
	CAS_Client::$_url
	the URL of the current request (without any ticket CGI parameter). More...
	CAS_Client::$_rebroadcast = false
	Boolean of whether to rebroadcast pgtIou/pgtId and logoutRequest, and array of the nodes. More...
	CAS_Client::$_rebroadcast_nodes = array()
const	CAS_Client::HOSTNAME = 0
	Constants used for determining rebroadcast node type. More...
const	CAS_Client::IP = 1
	CAS_Client::$_rebroadcast_headers = array()
	An array to store extra rebroadcast curl options. More...
const	CAS_Client::LOGOUT = 0
	Constants used for determining rebroadcast type (logout or pgtIou/pgtId). More...
const	CAS_Client::PGTIOU = 1

Detailed Description

Function Documentation

_authError()

CAS_Client::_authError (   $failure,   $cas_url,   $no_response,   $bad_response = '',   $cas_response = '',   $err_code = '',   $err_msg = ''  )

private

This method is used to print the HTML output when the user was not authenticated.

Parameters

string	$failure	the failure that occured
string	$cas_url	the URL the CAS server was asked for
bool	$no_response	the response from the CAS server (other parameters are ignored if true)
bool	$bad_response	bad response from the CAS server ($err_code and $err_msg ignored if true)
string	$cas_response	the response of the CAS server
int	$err_code	the error code given by the CAS server
string	$err_msg	the error message given by the CAS server

Returns

void

Definition at line 3849 of file Client.php.

References $_SERVER, $failure, $lang, CAS_VERSION_1_0, CAS_VERSION_2_0, CAS_VERSION_3_0, CAS_Client\getLangObj(), CAS_Client\getServerVersion(), CAS_Client\getURL(), CAS_Client\printHTMLFooter(), CAS_Client\printHTMLHeader(), phpCAS\trace(), phpCAS\traceBegin(), and phpCAS\traceExit().

      {
        phpCAS::traceBegin();
        $lang = $this->getLangObj();
        $this->printHTMLHeader($lang->getAuthenticationFailed());
        printf(
            $lang->getYouWereNotAuthenticated(),
            htmlentities($this->getURL()),
            isset($_SERVER['SERVER_ADMIN']) ? $_SERVER['SERVER_ADMIN']:''
        );
        phpCAS::trace('CAS URL: ' . $cas_url);
        phpCAS::trace('Authentication failure: ' . $failure);
        if ($no_response) {
            phpCAS::trace('Reason: no response from the CAS server');
        } else {
            if ($bad_response) {
                phpCAS::trace('Reason: bad response from the CAS server');
            } else {
                switch ($this->getServerVersion()) {
                case CAS_VERSION_1_0:
                    phpCAS::trace('Reason: CAS error');
                    break;
                case CAS_VERSION_2_0:
                case CAS_VERSION_3_0:
                    if (empty($err_code)) {
                        phpCAS::trace('Reason: no CAS error');
                    } else {
                        phpCAS::trace(
                            'Reason: [' . $err_code . '] CAS error: ' . $err_msg
                        );
                    }
                    break;
                }
            }
            phpCAS::trace('CAS response: ' . $cas_response);
        }
        $this->printHTMLFooter();
        phpCAS::traceExit();
        throw new CAS_GracefullTerminationException();
    }

Here is the call graph for this function:

_buildQueryUrl()

CAS_Client::_buildQueryUrl (   $url,   $query  )

private

This method is used to append query parameters to an url.

Since the url might already contain parameter it has to be detected and to build a proper URL

Parameters

string	$url	base url to add the query params to
string	$query	params in query form with & separated

Returns

url with query params

Definition at line 3787 of file Client.php.

References $query, and $url.

Referenced by CAS_Client\getServerLoginURL(), CAS_Client\getServerProxyValidateURL(), CAS_Client\getServerSamlValidateURL(), and CAS_Client\getServerServiceValidateURL().

    {
        $url .= (strstr($url, '?') === false) ? '?' : '&';
        $url .= $query;
        return $url;
    }

Here is the caller graph for this function:

_buildSAMLPayload()

CAS_Client::_buildSAMLPayload ( )

private

This method is used to build the SAML POST body sent to /samlValidate URL.

Returns

the SOAP-encased SAMLP artifact (the ticket).

Definition at line 2931 of file Client.php.

References CAS_Client\getTicket(), SAML_ASSERTION_ARTIFACT, SAML_ASSERTION_ARTIFACT_CLOSE, SAML_SOAP_BODY, SAML_SOAP_BODY_CLOSE, SAML_SOAP_ENV, SAML_SOAP_ENV_CLOSE, SAMLP_REQUEST, SAMLP_REQUEST_CLOSE, phpCAS\traceBegin(), and phpCAS\traceEnd().

Referenced by CAS_Client\_readURL().

    {
        phpCAS::traceBegin();

        //get the ticket
        $sa = urlencode($this->getTicket());

        $body = SAML_SOAP_ENV . SAML_SOAP_BODY . SAMLP_REQUEST
            . SAML_ASSERTION_ARTIFACT . $sa . SAML_ASSERTION_ARTIFACT_CLOSE
            . SAMLP_REQUEST_CLOSE . SAML_SOAP_BODY_CLOSE . SAML_SOAP_ENV_CLOSE;

        phpCAS::traceEnd($body);
        return ($body);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getClientUrl()

CAS_Client::_getClientUrl ( )

private

Try to figure out the phpCas client URL with possible Proxys / Ports etc.

Returns

string Server URL with domain:port

Definition at line 3702 of file Client.php.

References $_SERVER, and CAS_Client\_isHttps().

Referenced by CAS_Client\_getCallbackURL(), and CAS_Client\getURL().

    {
        $server_url = '';
        if (!empty($_SERVER['HTTP_X_FORWARDED_HOST'])) {
            // explode the host list separated by comma and use the first host
            $hosts = explode(',', $_SERVER['HTTP_X_FORWARDED_HOST']);
            // see rfc7239#5.3 and rfc7230#2.7.1: port is in HTTP_X_FORWARDED_HOST if non default
            return $hosts[0];
        } elseif (!empty($_SERVER['HTTP_X_FORWARDED_SERVER'])) {
            $server_url = $_SERVER['HTTP_X_FORWARDED_SERVER'];
        } else {
            if (empty($_SERVER['SERVER_NAME'])) {
                $server_url = $_SERVER['HTTP_HOST'];
            } else {
                $server_url = $_SERVER['SERVER_NAME'];
            }
        }
        if (!strpos($server_url, ':')) {
            if (empty($_SERVER['HTTP_X_FORWARDED_PORT'])) {
                $server_port = $_SERVER['SERVER_PORT'];
            } else {
                $ports = explode(',', $_SERVER['HTTP_X_FORWARDED_PORT']);
                $server_port = $ports[0];
            }

            if (($this->_isHttps() && $server_port != 443)
                || (!$this->_isHttps() && $server_port != 80)
            ) {
                $server_url .= ':';
                $server_url .= $server_port;
            }
        }
        return $server_url;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getNodeType()

CAS_Client::_getNodeType (   $nodeURL )

private

Determine the node type from the URL.

Parameters

String

$nodeURL

The node URL.

Returns

string hostname

Definition at line 3922 of file Client.php.

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

Referenced by CAS_Client\_rebroadcast().

    {
        phpCAS::traceBegin();
        if (preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/", $nodeURL)) {
            phpCAS::traceEnd(self::IP);
            return self::IP;
        } else {
            phpCAS::traceEnd(self::HOSTNAME);
            return self::HOSTNAME;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_isHttps()

CAS_Client::_isHttps ( )

private

This method checks to see if the request is secured via HTTPS.

Returns

bool true if https, false otherwise

Definition at line 3742 of file Client.php.

References $_SERVER.

Referenced by CAS_Client\__construct(), CAS_Client\_getClientUrl(), and CAS_Client\getURL().

    {
        if (!empty($_SERVER['HTTP_X_FORWARDED_PROTO'])) {
            return ($_SERVER['HTTP_X_FORWARDED_PROTO'] === 'https');
        } elseif (!empty($_SERVER['HTTP_X_FORWARDED_PROTOCOL'])) {
            return ($_SERVER['HTTP_X_FORWARDED_PROTOCOL'] === 'https');
        } elseif (isset($_SERVER['HTTPS'])
            && !empty($_SERVER['HTTPS'])
            && strcasecmp($_SERVER['HTTPS'], 'off') !== 0
        ) {
            return true;
        }
        return false;
    }

Here is the caller graph for this function:

_readURL()

CAS_Client::_readURL (   $url, &  $headers, &  $body, &  $err_msg  )

private

This method is used to acces a remote URL.

Parameters

string	$url	the URL to access.
string	&$headers	an array containing the HTTP header lines of the response (an empty array on failure).
string	&$body	the body of the response, as a string (empty on failure).
string	&$err_msg	an error message, filled on failure.

Returns

true on success, false otherwise (in this later case, $err_msg contains an error message).

Definition at line 2875 of file Client.php.

References CAS_Client\$_requestImplementation, $request, $url, CAS_Client\_buildSAMLPayload(), phpCAS\error(), CAS_Client\getServerVersion(), SAML_VERSION_1_1, phpCAS\traceBegin(), and phpCAS\traceEnd().

Referenced by CAS_Client\retrievePT(), CAS_Client\validateCAS10(), and CAS_Client\validateCAS20().

    {
        phpCAS::traceBegin();
        $className = $this->_requestImplementation;
        $request = new $className();

        if (count($this->_curl_options)) {
            $request->setCurlOptions($this->_curl_options);
        }

        $request->setUrl($url);

        if (empty($this->_cas_server_ca_cert) && !$this->_no_cas_server_validation) {
            phpCAS::error(
                'one of the methods phpCAS::setCasServerCACert() or phpCAS::setNoCasServerValidation() must be called.'
            );
        }
        if ($this->_cas_server_ca_cert != '') {
            $request->setSslCaCert(
                $this->_cas_server_ca_cert,
                $this->_cas_server_cn_validate
            );
        }

        // add extra stuff if SAML
        if ($this->getServerVersion() == SAML_VERSION_1_1) {
            $request->addHeader("soapaction: http://www.oasis-open.org/committees/security");
            $request->addHeader("cache-control: no-cache");
            $request->addHeader("pragma: no-cache");
            $request->addHeader("accept: text/xml");
            $request->addHeader("connection: keep-alive");
            $request->addHeader("content-type: text/xml");
            $request->makePost();
            $request->setPostBody($this->_buildSAMLPayload());
        }

        if ($request->send()) {
            $headers = $request->getResponseHeaders();
            $body = $request->getResponseBody();
            $err_msg = '';
            phpCAS::traceEnd(true);
            return true;
        } else {
            $headers = '';
            $body = '';
            $err_msg = $request->getErrorMessage();
            phpCAS::traceEnd(false);
            return false;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_rebroadcast()

CAS_Client::_rebroadcast (   $type )

private

This method rebroadcasts logout/pgtIou requests.

Can be LOGOUT,PGTIOU

Parameters

int

$type

type of rebroadcasting.

Returns

void

Definition at line 3988 of file Client.php.

References $_POST, CAS_Client\$_rebroadcast_nodes, CAS_Client\$_requestImplementation, $_SERVER, $i, $request, $type, $url, CAS_Client\_getNodeType(), phpCAS\trace(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Referenced by CAS_Client\_wasPreviouslyAuthenticated(), CAS_Client\addRebroadcastNode(), and CAS_Client\handleLogoutRequests().

    {
        phpCAS::traceBegin();

        $rebroadcast_curl_options = array(
        CURLOPT_FAILONERROR => 1,
        CURLOPT_FOLLOWLOCATION => 1,
        CURLOPT_RETURNTRANSFER => 1,
        CURLOPT_CONNECTTIMEOUT => 1,
        CURLOPT_TIMEOUT => 4);

        // Try to determine the IP address of the server
        if (!empty($_SERVER['SERVER_ADDR'])) {
            $ip = $_SERVER['SERVER_ADDR'];
        } elseif (!empty($_SERVER['LOCAL_ADDR'])) {
            // IIS 7
            $ip = $_SERVER['LOCAL_ADDR'];
        }
        // Try to determine the DNS name of the server
        if (!empty($ip)) {
            $dns = gethostbyaddr($ip);
        }
        $multiClassName = 'CAS_Request_CurlMultiRequest';
        $multiRequest = new $multiClassName();

        for ($i = 0; $i < sizeof($this->_rebroadcast_nodes); $i++) {
            if ((($this->_getNodeType($this->_rebroadcast_nodes[$i]) == self::HOSTNAME) && !empty($dns) && (stripos($this->_rebroadcast_nodes[$i], $dns) === false))
                || (($this->_getNodeType($this->_rebroadcast_nodes[$i]) == self::IP) && !empty($ip) && (stripos($this->_rebroadcast_nodes[$i], $ip) === false))
            ) {
                phpCAS::trace(
                    'Rebroadcast target URL: ' . $this->_rebroadcast_nodes[$i]
                    . $_SERVER['REQUEST_URI']
                );
                $className = $this->_requestImplementation;
                $request = new $className();

                $url = $this->_rebroadcast_nodes[$i] . $_SERVER['REQUEST_URI'];
                $request->setUrl($url);

                if (count($this->_rebroadcast_headers)) {
                    $request->addHeaders($this->_rebroadcast_headers);
                }

                $request->makePost();
                if ($type == self::LOGOUT) {
                    // Logout request
                    $request->setPostBody(
                        'rebroadcast=false&logoutRequest=' . $_POST['logoutRequest']
                    );
                } elseif ($type == self::PGTIOU) {
                    // pgtIou/pgtId rebroadcast
                    $request->setPostBody('rebroadcast=false');
                }

                $request->setCurlOptions($rebroadcast_curl_options);

                $multiRequest->addRequest($request);
            } else {
                phpCAS::trace(
                    'Rebroadcast not sent to self: '
                    . $this->_rebroadcast_nodes[$i] . ' == ' . (!empty($ip)?$ip:'')
                    . '/' . (!empty($dns)?$dns:'')
                );
            }
        }
        // We need at least 1 request
        if ($multiRequest->getNumRequests() > 0) {
            $multiRequest->send();
        }
        phpCAS::traceEnd();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_removeParameterFromQueryString()

CAS_Client::_removeParameterFromQueryString (   $parameterName,   $queryString  )

private

Removes a parameter from a query string.

Parameters

string	$parameterName	name of parameter
string	$queryString	query string

Returns

string new query string

http://stackoverflow.com/questions/1842681/regular-expression-to-remove-one-parameter-from-query-string

Definition at line 3767 of file Client.php.

Referenced by CAS_Client\getURL().

    {
        $parameterName = preg_quote($parameterName);
        return preg_replace(
            "/&$parameterName(=[^&]*)?|^$parameterName(=[^&]*)?&?/",
            '',
            $queryString
        );
    }

Here is the caller graph for this function:

_renameSession()

CAS_Client::_renameSession (   $ticket )

private

Renaming the session.

Parameters

string

$ticket

name of the ticket

Returns

void

Definition at line 3801 of file Client.php.

References $_SESSION, CAS_Client\getChangeSessionID(), phpCAS\trace(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Referenced by CAS_Client\validateSA().

    {
        phpCAS::traceBegin();
        if ($this->getChangeSessionID()) {
            if (!empty($this->_user)) {
                $old_session = $_SESSION;
                phpCAS :: trace("Killing session: " . session_id());
                session_destroy();
                // set up a new session, of name based on the ticket
                $session_id = preg_replace('/[^a-zA-Z0-9\-]/', '', $ticket);
                phpCAS :: trace("Starting session: " . $session_id);
                session_id($session_id);
                session_start();
                phpCAS :: trace("Restoring old session vars");
                $_SESSION = $old_session;
            } else {
                phpCAS :: trace(
                    'Session should only be renamed after successfull authentication'
                );
            }
        } else {
            phpCAS :: trace(
                "Skipping session rename since phpCAS is not handling the session."
            );
        }
        phpCAS::traceEnd();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addRebroadcastHeader()

CAS_Client::addRebroadcastHeader

(

$header

)

This method is used to add header parameters when rebroadcasting pgtIou/pgtId or logoutRequest.

Parameters

string

$header

Header to send when rebroadcasting.

Returns

void

Definition at line 3966 of file Client.php.

References $header.

    {
        if (gettype($header) != 'string') {
            throw new CAS_TypeMismatchException($header, '$header', 'string');
        }

        $this->_rebroadcast_headers[] = $header;
    }

addRebroadcastNode()

CAS_Client::addRebroadcastNode

(

$rebroadcastNodeUrl

)

Store the rebroadcast node for pgtIou/pgtId and logout requests.

Parameters

string

$rebroadcastNodeUrl

The rebroadcast node URL.

Returns

void

Definition at line 3941 of file Client.php.

References CAS_Client\_rebroadcast().

    {
        // Argument validation
        if (!(bool) preg_match("/^(http|https):\/\/([A-Z0-9][A-Z0-9_-]*(?:\.[A-Z0-9][A-Z0-9_-]*)+):?(\d+)?\/?/i", $rebroadcastNodeUrl)) {
            throw new CAS_TypeMismatchException($rebroadcastNodeUrl, '$rebroadcastNodeUrl', 'url');
        }

        // Store the rebroadcast node and set flag
        $this->_rebroadcast = true;
        $this->_rebroadcast_nodes[] = $rebroadcastNodeUrl;
    }

Here is the call graph for this function:

getURL()

CAS_Client::getURL

(

)

This method returns the URL of the current request (without any ticket CGI parameter).

Returns

The URL

Definition at line 3648 of file Client.php.

References $_SERVER, CAS_Client\$_url, CAS_Client\_getClientUrl(), CAS_Client\_isHttps(), CAS_Client\_removeParameterFromQueryString(), CAS_Client\setURL(), phpCAS\trace(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Referenced by CAS_Client\_authError(), CAS_Client\getServerLoginURL(), CAS_Client\getServerProxyValidateURL(), CAS_Client\getServerSamlValidateURL(), CAS_Client\getServerServiceValidateURL(), and CAS_Client\isAuthenticated().

    {
        phpCAS::traceBegin();
        // the URL is built when needed only
        if (empty($this->_url)) {
            $final_uri = '';
            // remove the ticket if present in the URL
            $final_uri = ($this->_isHttps()) ? 'https' : 'http';
            $final_uri .= '://';

            $final_uri .= $this->_getClientUrl();
            $request_uri = explode('?', $_SERVER['REQUEST_URI'], 2);
            $final_uri .= $request_uri[0];

            if (isset($request_uri[1]) && $request_uri[1]) {
                $query_string = $this->_removeParameterFromQueryString('ticket', $request_uri[1]);

                // If the query string still has anything left,
                // append it to the final URI
                if ($query_string !== '') {
                    $final_uri .= "?$query_string";
                }
            }

            phpCAS::trace("Final URI: $final_uri");
            $this->setURL($final_uri);
        }
        phpCAS::traceEnd($this->_url);
        return $this->_url;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setBaseURL()

CAS_Client::setBaseURL

(

$url

)

This method sets the base URL of the CAS server.

Parameters

string

$url

the base URL

Returns

string base url

Definition at line 3686 of file Client.php.

References $url.

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

        return $this->_server['base_url'] = $url;
    }

setURL()

CAS_Client::setURL

(

$url

)

This method sets the URL of the current request.

Parameters

string

$url

url to set for service

Returns

void

Definition at line 3632 of file Client.php.

References $url.

Referenced by CAS_Client\getURL().

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

        $this->_url = $url;
    }

Here is the caller graph for this function:

Variable Documentation

$_rebroadcast

CAS_Client::$_rebroadcast = false

private

Boolean of whether to rebroadcast pgtIou/pgtId and logoutRequest, and array of the nodes.

Definition at line 3905 of file Client.php.

$_rebroadcast_headers

CAS_Client::$_rebroadcast_headers = array()

private

An array to store extra rebroadcast curl options.

Definition at line 3956 of file Client.php.

$_rebroadcast_nodes

CAS_Client::$_rebroadcast_nodes = array()

private

Definition at line 3906 of file Client.php.

Referenced by CAS_Client\_rebroadcast().

$_url

CAS_Client::$_url

private

the URL of the current request (without any ticket CGI parameter).

Written and read by CAS_Client::getURL().

Definition at line 3622 of file Client.php.

Referenced by CAS_Client\getURL().

HOSTNAME

const CAS_Client::HOSTNAME = 0

Constants used for determining rebroadcast node type.

Definition at line 3911 of file Client.php.

IP

const CAS_Client::IP = 1

Definition at line 3912 of file Client.php.

LOGOUT

const CAS_Client::LOGOUT = 0

Constants used for determining rebroadcast type (logout or pgtIou/pgtId).

Definition at line 3978 of file Client.php.

PGTIOU

const CAS_Client::PGTIOU = 1

Definition at line 3979 of file Client.php.