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 ()

Function Documentation

static phpCAS::checkAuthentication (  )  [static, inherited]

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 1071 of file CAS.php.

References $auth, phpCAS::error(), phpCAS::traceBegin(), and phpCAS::traceEnd().

static phpCAS::forceAuthentication (  )  [static, inherited]
static phpCAS::getAttribute ( key  )  [static, inherited]

Answer an attribute for the authenticated user.

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

Definition at line 1272 of file CAS.php.

References phpCAS::error().

static phpCAS::getAttributes (  )  [static, inherited]

Answer attributes about the authenticated user.

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

Definition at line 1204 of file CAS.php.

References phpCAS::error().

static phpCAS::getServerLoginURL (  )  [static, inherited]

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

Returns:
the login name of the authenticated user

Definition at line 1308 of file CAS.php.

References phpCAS::error().

static phpCAS::getServerLogoutURL (  )  [static, inherited]

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

Returns:
the login name of the authenticated user

Definition at line 1405 of file CAS.php.

References phpCAS::error().

static phpCAS::getServiceURL (  )  [static, inherited]

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

Returns:
string Service Url

Definition at line 1605 of file CAS.php.

References phpCAS::error().

static phpCAS::getUser (  )  [static, inherited]

This method returns the CAS user's login name.

Returns:
string the login name of the authenticated user
Warning:
should not be called only 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 1182 of file CAS.php.

References phpCAS::error().

static phpCAS::handleLogoutRequests ( check_client = true,
allowed_clients = false 
) [static, inherited]

Handle logout requests.

Parameters:
bool $check_client additional safety check
array $allowed_clients array of allowed clients
Returns:
void
Examples:
example_advanced_saml11.php, and example_logout.php.

Definition at line 1294 of file CAS.php.

References phpCAS::error().

static phpCAS::hasAttribute ( key  )  [static, inherited]

Answer true if an attribute exists for the authenticated user.

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

Definition at line 1249 of file CAS.php.

References phpCAS::error().

static phpCAS::hasAttributes (  )  [static, inherited]

Answer true if there are attributes for the authenticated user.

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

Definition at line 1226 of file CAS.php.

References phpCAS::error().

static phpCAS::isAuthenticated (  )  [static, inherited]

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 1143 of file CAS.php.

References $auth, phpCAS::error(), phpCAS::traceBegin(), and phpCAS::traceEnd().

static phpCAS::isSessionAuthenticated (  )  [static, inherited]

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 1167 of file CAS.php.

References phpCAS::error().

static phpCAS::logout ( params = ""  )  [static, inherited]

This method is used to logout from CAS.

Parameters:
string $params an 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 1446 of file CAS.php.

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

static phpCAS::logoutWithRedirectService ( service  )  [static, inherited]

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

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

Definition at line 1480 of file CAS.php.

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

static phpCAS::logoutWithRedirectServiceAndUrl ( service,
url 
) [static, inherited]

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

Parameters:
string $service a URL that will be transmitted to the CAS server
string $url a 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 1531 of file CAS.php.

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

static phpCAS::logoutWithUrl ( url  )  [static, inherited]

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

Parameters:
string $url a 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 1504 of file CAS.php.

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

static phpCAS::renewAuthentication (  )  [static, inherited]

This method is called to renew the authentication.

Returns:
void

Definition at line 1122 of file CAS.php.

References $auth, phpCAS::error(), phpCAS::traceBegin(), and phpCAS::traceEnd().

static phpCAS::retrievePT ( target_service,
&$  err_code,
&$  err_msg 
) [static, inherited]

Retrieve a Proxy Ticket from the CAS server.

Parameters:
string $target_service Url string of service to proxy
string &$err_code error code
string &$err_msg error message
Returns:
string Proxy Ticket

Definition at line 1622 of file CAS.php.

References phpCAS::error().

static phpCAS::setCacheTimesForAuthRecheck ( n  )  [static, inherited]

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 $n an integer.
Returns:
void

Definition at line 999 of file CAS.php.

References phpCAS::error().

static phpCAS::setCasServerCACert ( cert,
validate_cn = true 
) [static, inherited]

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

Parameters:
string $cert CA certificate file name
bool $validate_cn Validate CN in certificate (default true)
Returns:
void
Examples:
example_advanced_saml11.php.

Definition at line 1642 of file CAS.php.

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

static phpCAS::setFixedCallbackURL ( url = ''  )  [static, inherited]

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 $url the URL
Returns:
void

Definition at line 1563 of file CAS.php.

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

static phpCAS::setFixedServiceURL ( url  )  [static, inherited]

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 $url the URL
Returns:
void

Definition at line 1587 of file CAS.php.

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

static phpCAS::setNoCasServerValidation (  )  [static, inherited]
static phpCAS::setNoClearTicketsFromUrl (  )  [static, inherited]

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 1684 of file CAS.php.

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

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

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 $function Callback function
array $additionalArgs optional array of arguments
Returns:
void

Definition at line 1029 of file CAS.php.

References phpCAS::error().

static phpCAS::setServerLoginURL ( url = ''  )  [static, inherited]

Set the login URL of the CAS server.

Parameters:
string $url the login URL
Returns:
void
Since:
0.4.21 by Wyman Chan

Definition at line 1324 of file CAS.php.

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

static phpCAS::setServerLogoutURL ( url = ''  )  [static, inherited]

Set the logout URL of the CAS server.

Parameters:
string $url the logout URL
Returns:
void
Since:
0.4.21 by Wyman Chan

Definition at line 1421 of file CAS.php.

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

static phpCAS::setServerProxyValidateURL ( url = ''  )  [static, inherited]

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

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

Definition at line 1366 of file CAS.php.

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

static phpCAS::setServerSamlValidateURL ( url = ''  )  [static, inherited]

Set the samlValidate URL of the CAS server.

Parameters:
string $url the samlValidate URL
Returns:
void

Definition at line 1386 of file CAS.php.

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

static phpCAS::setServerServiceValidateURL ( url = ''  )  [static, inherited]

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

Parameters:
string $url the serviceValidate URL
Returns:
void

Definition at line 1345 of file CAS.php.

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

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

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 $function Callback function
array $additionalArgs optional array of arguments
Returns:
void

Definition at line 1052 of file CAS.php.

References phpCAS::error().