phpCAS  version 1.3.3
Functions
Authentication
User interface

Functions

static phpCAS::setCacheTimesForAuthRecheck ($n)
static phpCAS::setPostAuthenticateCallback ($function, array $additionalArgs=array())
static phpCAS::setSingleSignoutCallback ($function, array $additionalArgs=array())
static phpCAS::checkAuthentication ()
static phpCAS::forceAuthentication ()
static phpCAS::renewAuthentication ()
static phpCAS::isAuthenticated ()
static phpCAS::isSessionAuthenticated ()
static phpCAS::getUser ()
static phpCAS::getAttributes ()
static phpCAS::hasAttributes ()
static phpCAS::hasAttribute ($key)
static phpCAS::getAttribute ($key)
static phpCAS::handleLogoutRequests ($check_client=true, $allowed_clients=false)
static phpCAS::getServerLoginURL ()
static phpCAS::setServerLoginURL ($url= '')
static phpCAS::setServerServiceValidateURL ($url= '')
static phpCAS::setServerProxyValidateURL ($url= '')
static phpCAS::setServerSamlValidateURL ($url= '')
static phpCAS::getServerLogoutURL ()
static phpCAS::setServerLogoutURL ($url= '')
static phpCAS::logout ($params="")
static phpCAS::logoutWithRedirectService ($service)
static phpCAS::logoutWithUrl ($url)
static phpCAS::logoutWithRedirectServiceAndUrl ($service, $url)
static phpCAS::setFixedCallbackURL ($url= '')
static phpCAS::setFixedServiceURL ($url)
static phpCAS::getServiceURL ()
static phpCAS::retrievePT ($target_service, &$err_code, &$err_msg)
static phpCAS::setCasServerCACert ($cert, $validate_cn=true)
static phpCAS::setNoCasServerValidation ()
static phpCAS::setNoClearTicketsFromUrl ()

Detailed Description

Function Documentation

static phpCAS::checkAuthentication ( )
static

This method is called to check if the user is already authenticated locally or has a global cas session. A already existing cas session is determined by a cas gateway call.(cas login call without any interactive prompt)

Returns
true when the user is authenticated, false when a previous gateway login failed or the function will not return if the user is redirected to the cas server for a gateway login attempt
Examples:
example_gateway.php.

Definition at line 990 of file CAS.php.

References $auth, phpCAS\_validateClientExists(), phpCAS\traceBegin(), and phpCAS\traceEnd().

static phpCAS::forceAuthentication ( )
static
static phpCAS::getAttribute (   $key)
static

Answer an attribute for the authenticated user.

Parameters
string$keyattribute name
Returns
mixed string for a single value or an array if multiple values exist.
Warning
should only be called after phpCAS::forceAuthentication() or phpCAS::checkAuthentication().

Definition at line 1170 of file CAS.php.

References phpCAS\_validateClientExists(), and phpCAS\error().

static phpCAS::getAttributes ( )
static

Answer attributes about the authenticated user.

Warning
should only be called after phpCAS::forceAuthentication() or phpCAS::checkAuthentication().
Returns
array
Examples:
example_advanced_saml11.php.

Definition at line 1111 of file CAS.php.

References phpCAS\_validateClientExists(), and phpCAS\error().

static phpCAS::getServerLoginURL ( )
static

This method returns the URL to be used to login. or phpCAS::isAuthenticated().

Returns
the login name of the authenticated user

Definition at line 1202 of file CAS.php.

References phpCAS\_validateClientExists().

static phpCAS::getServerLogoutURL ( )
static

This method returns the URL to be used to login. or phpCAS::isAuthenticated().

Returns
the login name of the authenticated user

Definition at line 1302 of file CAS.php.

References phpCAS\_validateClientExists().

static phpCAS::getServiceURL ( )
static

Get the URL that is set as the CAS service parameter.

Returns
string Service Url

Definition at line 1494 of file CAS.php.

References phpCAS\_validateProxyExists().

static phpCAS::getUser ( )
static

This method returns the CAS user's login name.

Returns
string the login name of the authenticated user
Warning
should only be called after phpCAS::forceAuthentication() or phpCAS::checkAuthentication().
Examples:
example_advanced_saml11.php, example_lang.php, example_service.php, and example_service_POST.php.

Definition at line 1092 of file CAS.php.

References phpCAS\_validateClientExists(), and phpCAS\error().

static phpCAS::handleLogoutRequests (   $check_client = true,
  $allowed_clients = false 
)
static

Handle logout requests.

Parameters
bool$check_clientadditional safety check
array$allowed_clientsarray of allowed clients
Returns
void
Examples:
example_advanced_saml11.php, and example_logout.php.

Definition at line 1189 of file CAS.php.

References phpCAS\_validateClientExists().

static phpCAS::hasAttribute (   $key)
static

Answer true if an attribute exists for the authenticated user.

Parameters
string$keyattribute name
Returns
bool
Warning
should only be called after phpCAS::forceAuthentication() or phpCAS::checkAuthentication().

Definition at line 1150 of file CAS.php.

References phpCAS\_validateClientExists(), and phpCAS\error().

static phpCAS::hasAttributes ( )
static

Answer true if there are attributes for the authenticated user.

Warning
should only be called after phpCAS::forceAuthentication() or phpCAS::checkAuthentication().
Returns
bool

Definition at line 1130 of file CAS.php.

References phpCAS\_validateClientExists(), and phpCAS\error().

static phpCAS::isAuthenticated ( )
static

This method is called to check if the user is authenticated (previously or by tickets given in the URL).

Returns
true when the user is authenticated.

Definition at line 1056 of file CAS.php.

References $auth, phpCAS\_validateClientExists(), phpCAS\traceBegin(), and phpCAS\traceEnd().

static phpCAS::isSessionAuthenticated ( )
static

Checks whether authenticated based on $_SESSION. Useful to avoid server calls.

Returns
bool true if authenticated, false otherwise.
Since
0.4.22 by Brendan Arnold

Definition at line 1078 of file CAS.php.

References phpCAS\_validateClientExists().

static phpCAS::logout (   $params = "")
static

This method is used to logout from CAS.

Parameters
string$paramsan array that contains the optional url and service parameters that will be passed to the CAS server
Returns
void
Examples:
example_advanced_saml11.php, example_custom_urls.php, example_gateway.php, and example_simple.php.

Definition at line 1339 of file CAS.php.

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

static phpCAS::logoutWithRedirectService (   $service)
static

This method is used to logout from CAS. Halts by redirecting to the CAS server.

Parameters
service$servicea URL that will be transmitted to the CAS server
Returns
void

Definition at line 1372 of file CAS.php.

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

static phpCAS::logoutWithRedirectServiceAndUrl (   $service,
  $url 
)
static

This method is used to logout from CAS. Halts by redirecting to the CAS server.

Parameters
string$servicea URL that will be transmitted to the CAS server
string$urla URL that will be transmitted to the CAS server
Returns
void
Deprecated:
The url parameter has been removed from the CAS server as of version 3.3.5.1

Definition at line 1422 of file CAS.php.

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

static phpCAS::logoutWithUrl (   $url)
static

This method is used to logout from CAS. Halts by redirecting to the CAS server.

Parameters
string$urla URL that will be transmitted to the CAS server
Returns
void
Deprecated:
The url parameter has been removed from the CAS server as of version 3.3.5.1

Definition at line 1395 of file CAS.php.

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

static phpCAS::renewAuthentication ( )
static

This method is called to renew the authentication.

Returns
void

Definition at line 1036 of file CAS.php.

References $auth, phpCAS\_validateClientExists(), phpCAS\traceBegin(), and phpCAS\traceEnd().

static phpCAS::retrievePT (   $target_service,
$err_code,
$err_msg 
)
static

Retrieve a Proxy Ticket from the CAS server.

Parameters
string$target_serviceUrl string of service to proxy
string&$err_codeerror code
string&$err_msgerror message
Returns
string Proxy Ticket

Definition at line 1509 of file CAS.php.

References phpCAS\_validateProxyExists(), and phpCAS\error().

static phpCAS::setCacheTimesForAuthRecheck (   $n)
static

Set the times authentication will be cached before really accessing the CAS server in gateway mode:

  • -1: check only once, and then never again (until you pree login)
  • 0: always check
  • n: check every "n" time
Parameters
int$nan integer.
Returns
void

Definition at line 922 of file CAS.php.

References phpCAS\_validateClientExists(), and phpCAS\error().

static phpCAS::setCasServerCACert (   $cert,
  $validate_cn = true 
)
static

Set the certificate of the CAS server CA and if the CN should be properly verified.

Parameters
string$certCA certificate file name
bool$validate_cnValidate CN in certificate (default true)
Returns
void
Examples:
example_advanced_saml11.php.

Definition at line 1529 of file CAS.php.

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

static phpCAS::setFixedCallbackURL (   $url = '')
static

Set the fixed URL that will be used by the CAS server to transmit the PGT. When this method is not called, a phpCAS script uses its own URL for the callback.

Parameters
string$urlthe URL
Returns
void

Definition at line 1453 of file CAS.php.

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

static phpCAS::setFixedServiceURL (   $url)
static

Set the fixed URL that will be set as the CAS service parameter. When this method is not called, a phpCAS script uses its own URL.

Parameters
string$urlthe URL
Returns
void

Definition at line 1475 of file CAS.php.

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

static phpCAS::setNoCasServerValidation ( )
static
static phpCAS::setNoClearTicketsFromUrl ( )
static

Disable the removal of a CAS-Ticket from the URL when authenticating DISABLING POSES A SECURITY RISK: We normally remove the ticket by an additional redirect as a security precaution to prevent a ticket in the HTTP_REFERRER or be carried over in the URL parameter

Returns
void

Definition at line 1568 of file CAS.php.

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

static phpCAS::setPostAuthenticateCallback (   $function,
array  $additionalArgs = array() 
)
static

Set a callback function to be run when a user authenticates.

The callback function will be passed a $logoutTicket as its first parameter, followed by any $additionalArgs you pass. The $logoutTicket parameter is an opaque string that can be used to map the session-id to logout request in order to support single-signout in applications that manage their own sessions (rather than letting phpCAS start the session).

phpCAS::forceAuthentication() will always exit and forward client unless they are already authenticated. To perform an action at the moment the user logs in (such as registering an account, performing logging, etc), register a callback function here.

Parameters
string$functionCallback function
array$additionalArgsoptional array of arguments
Returns
void

Definition at line 952 of file CAS.php.

References phpCAS\_validateClientExists().

static phpCAS::setServerLoginURL (   $url = '')
static

Set the login URL of the CAS server.

Parameters
string$urlthe login URL
Returns
void
Since
0.4.21 by Wyman Chan

Definition at line 1217 of file CAS.php.

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

static phpCAS::setServerLogoutURL (   $url = '')
static

Set the logout URL of the CAS server.

Parameters
string$urlthe logout URL
Returns
void
Since
0.4.21 by Wyman Chan

Definition at line 1317 of file CAS.php.

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

static phpCAS::setServerProxyValidateURL (   $url = '')
static

Set the proxyValidate URL of the CAS server. Used for all CAS 2.0 validations

Parameters
string$urlthe proxyValidate URL
Returns
void
Examples:
example_custom_urls.php.

Definition at line 1261 of file CAS.php.

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

static phpCAS::setServerSamlValidateURL (   $url = '')
static

Set the samlValidate URL of the CAS server.

Parameters
string$urlthe samlValidate URL
Returns
void

Definition at line 1282 of file CAS.php.

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

static phpCAS::setServerServiceValidateURL (   $url = '')
static

Set the serviceValidate URL of the CAS server. Used only in CAS 1.0 validations

Parameters
string$urlthe serviceValidate URL
Returns
void

Definition at line 1239 of file CAS.php.

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

static phpCAS::setSingleSignoutCallback (   $function,
array  $additionalArgs = array() 
)
static

Set a callback function to be run when a single-signout request is received. The callback function will be passed a $logoutTicket as its first parameter, followed by any $additionalArgs you pass. The $logoutTicket parameter is an opaque string that can be used to map a session-id to the logout request in order to support single-signout in applications that manage their own sessions (rather than letting phpCAS start and destroy the session).

Parameters
string$functionCallback function
array$additionalArgsoptional array of arguments
Returns
void

Definition at line 973 of file CAS.php.

References phpCAS\_validateClientExists().