Configuration

Collaboration diagram for Configuration:

Modules
	Internal behaviour of phpCAS
	HTML output
	Internationalization
	To add a new language:

Functions
	CAS_Client::getServerVersion ()
	This method is used to retrieve the version of the CAS server. More...
	CAS_Client::_getServerHostname ()
	This method is used to retrieve the hostname of the CAS server. More...
	CAS_Client::_getServerPort ()
	This method is used to retrieve the port of the CAS server. More...
	CAS_Client::_getServerURI ()
	This method is used to retrieve the URI of the CAS server. More...
	CAS_Client::_getServerBaseURL ()
	This method is used to retrieve the base URL of the CAS server. More...
	CAS_Client::getServerLoginURL ($gateway=false, $renew=false)
	This method is used to retrieve the login URL of the CAS server. More...
	CAS_Client::setServerLoginURL ($url)
	This method sets the login URL of the CAS server. More...
	CAS_Client::setServerServiceValidateURL ($url)
	This method sets the serviceValidate URL of the CAS server. More...
	CAS_Client::setServerProxyValidateURL ($url)
	This method sets the proxyValidate URL of the CAS server. More...
	CAS_Client::setServerSamlValidateURL ($url)
	This method sets the samlValidate URL of the CAS server. More...
	CAS_Client::getServerServiceValidateURL ()
	This method is used to retrieve the service validating URL of the CAS server. More...
	CAS_Client::getServerSamlValidateURL ()
	This method is used to retrieve the SAML validating URL of the CAS server. More...
	CAS_Client::getServerProxyValidateURL ()
	This method is used to retrieve the proxy validating URL of the CAS server. More...
	CAS_Client::getServerProxyURL ()
	This method is used to retrieve the proxy URL of the CAS server. More...
	CAS_Client::getServerLogoutURL ()
	This method is used to retrieve the logout URL of the CAS server. More...
	CAS_Client::setServerLogoutURL ($url)
	This method sets the logout URL of the CAS server. More...
	CAS_Client::setExtraCurlOption ($key, $value)
	This method is used to set additional user curl options. More...
	CAS_Client::__construct ( $server_version, $proxy, $server_hostname, $server_port, $server_uri, $changeSessionID=true)
	CAS_Client constructor. More...
	CAS_Client::_setChangeSessionID ($allowed)
	Set a parameter whether to allow phpCas to change session_id. More...
	CAS_Client::getChangeSessionID ()
	Get whether phpCas is allowed to change session_id. More...

Variables
	CAS_Client::$_server
	a record to store information about the CAS server. More...
	CAS_Client::$_curl_options = array()
	An array to store extra curl options. More...
	CAS_Client::$_change_session_id
	A variable to whether phpcas will use its own session handling. More...

Detailed Description

Function Documentation

__construct()

CAS_Client::__construct	(		$server_version,
			$proxy,
			$server_hostname,
			$server_port,
			$server_uri,
			$changeSessionID = true
	)

CAS_Client constructor.

Parameters

string	$server_version	the version of the CAS server
bool	$proxy	true if the CAS client is a CAS proxy
string	$server_hostname	the hostname of the CAS server
int	$server_port	the port the CAS server is running on
string	$server_uri	the URI the CAS server is responding on
bool	$changeSessionID	Allow phpCAS to change the session_id (Single Sign Out/handleLogoutRequests is based on that change)

Returns

a newly created CAS_Client object

Definition at line 911 of file Client.php.

      {
        // Argument validation
        if (gettype($server_version) != 'string') {
            throw new CAS_TypeMismatchException($server_version, '$server_version', 'string');
        }
        if (gettype($proxy) != 'boolean') {
            throw new CAS_TypeMismatchException($proxy, '$proxy', 'boolean');
        }
        if (gettype($server_hostname) != 'string') {
            throw new CAS_TypeMismatchException($server_hostname, '$server_hostname', 'string');
        }
        if (gettype($server_port) != 'integer') {
            throw new CAS_TypeMismatchException($server_port, '$server_port', 'integer');
        }
        if (gettype($server_uri) != 'string') {
            throw new CAS_TypeMismatchException($server_uri, '$server_uri', 'string');
        }
        if (gettype($changeSessionID) != 'boolean') {
            throw new CAS_TypeMismatchException($changeSessionID, '$changeSessionID', 'boolean');
        }
 
        phpCAS::traceBegin();
        // true : allow to change the session_id(), false session_id won't be
        // change and logout won't be handle because of that
        $this->_setChangeSessionID($changeSessionID);
 
        // skip Session Handling for logout requests and if don't want it'
        if (session_id() == "" && !$this->_isLogoutRequest()) {
            session_start();
            phpCAS :: trace("Starting a new session " . session_id());
        }
        // Only for debug purposes
        if ($this->isSessionAuthenticated()) {
            phpCAS :: trace("Session is authenticated as: " . $_SESSION['phpCAS']['user']);
        } else {
            phpCAS :: trace("Session is not authenticated");
        }
        // are we in proxy mode ?
        $this->_proxy = $proxy;
 
        // Make cookie handling available.
        if ($this->isProxy()) {
            if (!isset($_SESSION['phpCAS'])) {
                $_SESSION['phpCAS'] = array();
            }
            if (!isset($_SESSION['phpCAS']['service_cookies'])) {
                $_SESSION['phpCAS']['service_cookies'] = array();
            }
            $this->_serviceCookieJar = new CAS_CookieJar(
                $_SESSION['phpCAS']['service_cookies']
            );
        }
 
        //check version
        switch ($server_version) {
        case CAS_VERSION_1_0:
            if ($this->isProxy()) {
                phpCAS::error(
                    'CAS proxies are not supported in CAS ' . $server_version
                );
            }
            break;
        case CAS_VERSION_2_0:
        case CAS_VERSION_3_0:
            break;
        case SAML_VERSION_1_1:
            break;
        default:
            phpCAS::error(
                'this version of CAS (`' . $server_version
                . '\') is not supported by phpCAS ' . phpCAS::getVersion()
            );
        }
        $this->_server['version'] = $server_version;
 
        // check hostname
        if (empty($server_hostname)
            || !preg_match('/[\.\d\-abcdefghijklmnopqrstuvwxyz]*/', $server_hostname)
        ) {
            phpCAS::error('bad CAS server hostname (`' . $server_hostname . '\')');
        }
        $this->_server['hostname'] = $server_hostname;
 
        // check port
        if ($server_port == 0
            || !is_int($server_port)
        ) {
            phpCAS::error('bad CAS server port (`' . $server_hostname . '\')');
        }
        $this->_server['port'] = $server_port;
 
        // check URI
        if (!preg_match('/[\.\d\-_abcdefghijklmnopqrstuvwxyz\/]*/', $server_uri)) {
            phpCAS::error('bad CAS server URI (`' . $server_uri . '\')');
        }
        // add leading and trailing `/' and remove doubles
        if (strstr($server_uri, '?') === false) {
            $server_uri .= '/';
        }
        $server_uri = preg_replace('/\/\//', '/', '/' . $server_uri);
        $this->_server['uri'] = $server_uri;
 
        // set to callback mode if PgtIou and PgtId CGI GET parameters are provided
        if ($this->isProxy()) {
            $this->_setCallbackMode(!empty($_GET['pgtIou']) && !empty($_GET['pgtId']));
        }
 
        if ($this->_isCallbackMode()) {
            //callback mode: check that phpCAS is secured
            if (!$this->_isHttps()) {
                phpCAS::error(
                    'CAS proxies must be secured to use phpCAS; PGT\'s will not be received from the CAS server'
                );
            }
        } else {
            //normal mode: get ticket and remove it from CGI parameters for
            // developers
            $ticket = (isset($_GET['ticket']) ? $_GET['ticket'] : null);
            if (preg_match('/^[SP]T-/', $ticket)) {
                phpCAS::trace('Ticket \'' . $ticket . '\' found');
                $this->setTicket($ticket);
                unset($_GET['ticket']);
            } elseif (!empty($ticket)) {
                //ill-formed ticket, halt
                phpCAS::error(
                    'ill-formed ticket found in the URL (ticket=`'
                    . htmlentities($ticket) . '\')'
                );
            }
        }
        phpCAS::traceEnd();
    }

References $_GET, $_SESSION, CAS_Client\_isCallbackMode(), CAS_Client\_isHttps(), CAS_Client\_isLogoutRequest(), CAS_Client\_setCallbackMode(), CAS_Client\_setChangeSessionID(), CAS_VERSION_1_0, CAS_VERSION_2_0, CAS_VERSION_3_0, phpCAS\error(), CAS_Client\isProxy(), CAS_Client\isSessionAuthenticated(), SAML_VERSION_1_1, phpCAS\trace(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Here is the call graph for this function:

_getServerBaseURL()

CAS_Client::_getServerBaseURL ( )

private

This method is used to retrieve the base URL of the CAS server.

Returns

string a URL.

Definition at line 317 of file Client.php.

    {
        // the URL is build only when needed
        if (empty($this->_server['base_url'])) {
            $this->_server['base_url'] = 'https://' . $this->_getServerHostname();
            if ($this->_getServerPort() != 443) {
                $this->_server['base_url'] .= ':'
                . $this->_getServerPort();
            }
            $this->_server['base_url'] .= $this->_getServerURI();
        }
        return $this->_server['base_url'];
    }

References CAS_Client\_getServerHostname(), CAS_Client\_getServerPort(), and CAS_Client\_getServerURI().

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

Here is the call graph for this function:

Here is the caller graph for this function:

_getServerHostname()

CAS_Client::_getServerHostname ( )

private

This method is used to retrieve the hostname of the CAS server.

Returns

string the hostname of the CAS server.

Definition at line 287 of file Client.php.

    {
        return $this->_server['hostname'];
    }

Referenced by CAS_Client\_getServerBaseURL(), and CAS_Client\handleLogoutRequests().

Here is the caller graph for this function:

_getServerPort()

CAS_Client::_getServerPort ( )

private

This method is used to retrieve the port of the CAS server.

Returns

string the port of the CAS server.

Definition at line 297 of file Client.php.

    {
        return $this->_server['port'];
    }

Referenced by CAS_Client\_getServerBaseURL().

Here is the caller graph for this function:

_getServerURI()

CAS_Client::_getServerURI ( )

private

This method is used to retrieve the URI of the CAS server.

Returns

string a URI.

Definition at line 307 of file Client.php.

    {
        return $this->_server['uri'];
    }

Referenced by CAS_Client\_getServerBaseURL().

Here is the caller graph for this function:

_setChangeSessionID()

CAS_Client::_setChangeSessionID (   $allowed )

private

Set a parameter whether to allow phpCas to change session_id.

Parameters

bool

$allowed

allow phpCas to change session_id

Returns

void

Definition at line 1078 of file Client.php.

    {
        $this->_change_session_id = $allowed;
    }

Referenced by CAS_Client\__construct().

Here is the caller graph for this function:

getChangeSessionID()

CAS_Client::getChangeSessionID

(

)

Get whether phpCas is allowed to change session_id.

Returns

bool

Definition at line 1088 of file Client.php.

    {
        return $this->_change_session_id;
    }

References CAS_Client\$_change_session_id.

Referenced by CAS_Client\_renameSession(), and CAS_Client\handleLogoutRequests().

Here is the caller graph for this function:

getServerLoginURL()

CAS_Client::getServerLoginURL	(		$gateway = false,
			$renew = false
	)

This method is used to retrieve the login URL of the CAS server.

Parameters

bool	$gateway	true to check authentication, false to force it
bool	$renew	true to force the authentication with the CAS server

Returns

a URL.

Note

It is recommended that CAS implementations ignore the "gateway" parameter if "renew" is set

Definition at line 341 of file Client.php.

    {
        phpCAS::traceBegin();
        // the URL is build only when needed
        if (empty($this->_server['login_url'])) {
            $this->_server['login_url'] = $this->_buildQueryUrl($this->_getServerBaseURL() . 'login', 'service=' . urlencode($this->getURL()));
        }
        $url = $this->_server['login_url'];
        if ($renew) {
            // It is recommended that when the "renew" parameter is set, its
            // value be "true"
            $url = $this->_buildQueryUrl($url, 'renew=true');
        } elseif ($gateway) {
            // It is recommended that when the "gateway" parameter is set, its
            // value be "true"
            $url = $this->_buildQueryUrl($url, 'gateway=true');
        }
        phpCAS::traceEnd($url);
        return $url;
    }

References $url, CAS_Client\_buildQueryUrl(), CAS_Client\_getServerBaseURL(), CAS_Client\getURL(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Referenced by CAS_Client\redirectToCas().

Here is the call graph for this function:

Here is the caller graph for this function:

getServerLogoutURL()

CAS_Client::getServerLogoutURL

(

)

This method is used to retrieve the logout URL of the CAS server.

Returns

string logout URL.

Definition at line 549 of file Client.php.

    {
        // the URL is build only when needed
        if (empty($this->_server['logout_url'])) {
            $this->_server['logout_url'] = $this->_getServerBaseURL() . 'logout';
        }
        return $this->_server['logout_url'];
    }

References CAS_Client\_getServerBaseURL().

Referenced by CAS_Client\logout().

Here is the call graph for this function:

Here is the caller graph for this function:

getServerProxyURL()

CAS_Client::getServerProxyURL

(

)

This method is used to retrieve the proxy URL of the CAS server.

Returns

string proxy URL.

Definition at line 527 of file Client.php.

    {
        // the URL is build only when needed
        if (empty($this->_server['proxy_url'])) {
            switch ($this->getServerVersion()) {
            case CAS_VERSION_1_0:
                $this->_server['proxy_url'] = '';
                break;
            case CAS_VERSION_2_0:
            case CAS_VERSION_3_0:
                $this->_server['proxy_url'] = $this->_getServerBaseURL() . 'proxy';
                break;
            }
        }
        return $this->_server['proxy_url'];
    }

References CAS_Client\_getServerBaseURL(), CAS_VERSION_1_0, CAS_VERSION_2_0, CAS_VERSION_3_0, and CAS_Client\getServerVersion().

Referenced by CAS_Client\retrievePT().

Here is the call graph for this function:

Here is the caller graph for this function:

getServerProxyValidateURL()

CAS_Client::getServerProxyValidateURL

(

)

This method is used to retrieve the proxy validating URL of the CAS server.

Returns

string proxyValidate URL.

Definition at line 496 of file Client.php.

    {
        phpCAS::traceBegin();
        // the URL is build only when needed
        if (empty($this->_server['proxy_validate_url'])) {
            switch ($this->getServerVersion()) {
            case CAS_VERSION_1_0:
                $this->_server['proxy_validate_url'] = '';
                break;
            case CAS_VERSION_2_0:
                $this->_server['proxy_validate_url'] = $this->_getServerBaseURL() . 'proxyValidate';
                break;
            case CAS_VERSION_3_0:
                $this->_server['proxy_validate_url'] = $this->_getServerBaseURL() . 'p3/proxyValidate';
                break;
            }
        }
        $url = $this->_buildQueryUrl(
            $this->_server['proxy_validate_url'],
            'service=' . urlencode($this->getURL())
        );
        phpCAS::traceEnd($url);
        return $url;
    }

References $url, CAS_Client\_buildQueryUrl(), CAS_Client\_getServerBaseURL(), CAS_VERSION_1_0, CAS_VERSION_2_0, CAS_VERSION_3_0, CAS_Client\getServerVersion(), CAS_Client\getURL(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Referenced by CAS_Client\validateCAS20().

Here is the call graph for this function:

Here is the caller graph for this function:

getServerSamlValidateURL()

CAS_Client::getServerSamlValidateURL

(

)

This method is used to retrieve the SAML validating URL of the CAS server.

Returns

string samlValidate URL.

Definition at line 471 of file Client.php.

    {
        phpCAS::traceBegin();
        // the URL is build only when needed
        if (empty($this->_server['saml_validate_url'])) {
            switch ($this->getServerVersion()) {
            case SAML_VERSION_1_1:
                $this->_server['saml_validate_url'] = $this->_getServerBaseURL() . 'samlValidate';
                break;
            }
        }
 
        $url = $this->_buildQueryUrl(
            $this->_server['saml_validate_url'],
            'TARGET=' . urlencode($this->getURL())
        );
        phpCAS::traceEnd($url);
        return $url;
    }

References $url, CAS_Client\_buildQueryUrl(), CAS_Client\_getServerBaseURL(), CAS_Client\getServerVersion(), CAS_Client\getURL(), SAML_VERSION_1_1, phpCAS\traceBegin(), and phpCAS\traceEnd().

Here is the call graph for this function:

getServerServiceValidateURL()

CAS_Client::getServerServiceValidateURL

(

)

This method is used to retrieve the service validating URL of the CAS server.

Returns

string serviceValidate URL.

Definition at line 439 of file Client.php.

    {
        phpCAS::traceBegin();
        // the URL is build only when needed
        if (empty($this->_server['service_validate_url'])) {
            switch ($this->getServerVersion()) {
            case CAS_VERSION_1_0:
                $this->_server['service_validate_url'] = $this->_getServerBaseURL()
                . 'validate';
                break;
            case CAS_VERSION_2_0:
                $this->_server['service_validate_url'] = $this->_getServerBaseURL()
                . 'serviceValidate';
                break;
            case CAS_VERSION_3_0:
                $this->_server['service_validate_url'] = $this->_getServerBaseURL()
                . 'p3/serviceValidate';
                break;
            }
        }
        $url = $this->_buildQueryUrl(
            $this->_server['service_validate_url'],
            'service=' . urlencode($this->getURL())
        );
        phpCAS::traceEnd($url);
        return $url;
    }

References $url, CAS_Client\_buildQueryUrl(), CAS_Client\_getServerBaseURL(), CAS_VERSION_1_0, CAS_VERSION_2_0, CAS_VERSION_3_0, CAS_Client\getServerVersion(), CAS_Client\getURL(), phpCAS\traceBegin(), and phpCAS\traceEnd().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getServerVersion()

CAS_Client::getServerVersion

(

)

This method is used to retrieve the version of the CAS server.

Returns

string the version of the CAS server.

Definition at line 277 of file Client.php.

    {
        return $this->_server['version'];
    }

Referenced by CAS_Client\_authError(), CAS_Client\_htmlFilterOutput(), CAS_Client\_readURL(), CAS_Client\getServerProxyURL(), CAS_Client\getServerProxyValidateURL(), CAS_Client\getServerSamlValidateURL(), CAS_Client\getServerServiceValidateURL(), and CAS_Client\isAuthenticated().

Here is the caller graph for this function:

setExtraCurlOption()

CAS_Client::setExtraCurlOption	(		$key,
			$value
	)

This method is used to set additional user curl options.

Parameters

string	$key	name of the curl option
string	$value	value of the curl option

Returns

void

Definition at line 588 of file Client.php.

    {
        $this->_curl_options[$key] = $value;
    }

setServerLoginURL()

CAS_Client::setServerLoginURL

(

$url

)

This method sets the login URL of the CAS server.

Parameters

string

$url

the login URL

Returns

string login url

Definition at line 369 of file Client.php.

    {
        // Argument Validation
        if (gettype($url) != 'string') {
            throw new CAS_TypeMismatchException($url, '$url', 'string');
        }
 
        return $this->_server['login_url'] = $url;
    }

References $url.

setServerLogoutURL()

CAS_Client::setServerLogoutURL

(

$url

)

This method sets the logout URL of the CAS server.

Parameters

string

$url

the logout URL

Returns

string logout url

Definition at line 565 of file Client.php.

    {
        // Argument Validation
        if (gettype($url) != 'string') {
            throw new CAS_TypeMismatchException($url, '$url', 'string');
        }
 
        return $this->_server['logout_url'] = $url;
    }

References $url.

setServerProxyValidateURL()

CAS_Client::setServerProxyValidateURL

(

$url

)

This method sets the proxyValidate URL of the CAS server.

Parameters

string

$url

the proxyValidate URL

Returns

string proxyValidate URL

Definition at line 405 of file Client.php.

    {
        // Argument Validation
        if (gettype($url) != 'string') {
            throw new CAS_TypeMismatchException($url, '$url', 'string');
        }
 
        return $this->_server['proxy_validate_url'] = $url;
    }

References $url.

setServerSamlValidateURL()

CAS_Client::setServerSamlValidateURL

(

$url

)

This method sets the samlValidate URL of the CAS server.

Parameters

string

$url

the samlValidate URL

Returns

string samlValidate URL

Definition at line 423 of file Client.php.

    {
        // Argument Validation
        if (gettype($url) != 'string') {
            throw new CAS_TypeMismatchException($url, '$url', 'string');
        }
 
        return $this->_server['saml_validate_url'] = $url;
    }

References $url.

setServerServiceValidateURL()

CAS_Client::setServerServiceValidateURL

(

$url

)

This method sets the serviceValidate URL of the CAS server.

Parameters

string

$url

the serviceValidate URL

Returns

string serviceValidate URL

Definition at line 387 of file Client.php.

    {
        // Argument Validation
        if (gettype($url) != 'string') {
            throw new CAS_TypeMismatchException($url, '$url', 'string');
        }
 
        return $this->_server['service_validate_url'] = $url;
    }

References $url.

Variable Documentation

$_change_session_id

CAS_Client::$_change_session_id

private

A variable to whether phpcas will use its own session handling.

Default = true

Definition at line 1069 of file Client.php.

Referenced by CAS_Client\getChangeSessionID().

$_curl_options

CAS_Client::$_curl_options = array()

private

An array to store extra curl options.

Definition at line 578 of file Client.php.

$_server

CAS_Client::$_server

private

a record to store information about the CAS server.

• $_server['version']: the version of the CAS server
• $_server['hostname']: the hostname of the CAS server
• $_server['port']: the port the CAS server is running on
• $_server['uri']: the base URI the CAS server is responding on
• $_server['base_url']: the base URL of the CAS server
• $_server['login_url']: the login URL of the CAS server
• $_server['service_validate_url']: the service validating URL of the CAS server
• $_server['proxy_url']: the proxy URL of the CAS server
• $_server['proxy_validate_url']: the proxy validating URL of the CAS server
• $_server['logout_url']: the logout URL of the CAS server

$_server['version'], $_server['hostname'], $_server['port'] and $_server['uri'] are written by CAS_Client::CAS_Client(), read by CAS_Client::getServerVersion(), CAS_Client::_getServerHostname(), CAS_Client::_getServerPort() and CAS_Client::_getServerURI().

The other fields are written and read by CAS_Client::_getServerBaseURL(), CAS_Client::getServerLoginURL(), CAS_Client::getServerServiceValidateURL(), CAS_Client::getServerProxyValidateURL() and CAS_Client::getServerLogoutURL().

Definition at line 266 of file Client.php.