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)
Definition at line 1045 of file CAS.php.
References $auth, phpCAS::error(), phpCAS::traceBegin(), and phpCAS::traceEnd().
static phpCAS::forceAuthentication | ( | ) | [static, inherited] |
This method is called to force authentication if the user was not already authenticated. If the user is not authenticated, halt by redirecting to the CAS server.
Definition at line 1073 of file CAS.php.
References $auth, phpCAS::error(), phpCAS::getUser(), phpCAS::trace(), and phpCAS::traceBegin().
static phpCAS::getAttribute | ( | $ | key | ) | [static, inherited] |
static phpCAS::getAttributes | ( | ) | [static, inherited] |
Answer attributes about the authenticated user.
static phpCAS::getServerLoginURL | ( | ) | [static, inherited] |
static phpCAS::getServerLogoutURL | ( | ) | [static, inherited] |
This method returns the URL to be used to login. or phpCAS::isAuthenticated().
Definition at line 1397 of file CAS.php.
References phpCAS::error().
static phpCAS::getServiceURL | ( | ) | [static, inherited] |
Get the URL that is set as the CAS service parameter.
Definition at line 1569 of file CAS.php.
References phpCAS::error().
static phpCAS::getUser | ( | ) | [static, inherited] |
This method returns the CAS user's login name.
Definition at line 1180 of file CAS.php.
Referenced by phpCAS::forceAuthentication().
static phpCAS::handleLogoutRequests | ( | $ | check_client = true , |
|
$ | allowed_clients = false | |||
) | [static, inherited] |
Handle logout requests.
static phpCAS::hasAttribute | ( | $ | key | ) | [static, inherited] |
static phpCAS::hasAttributes | ( | ) | [static, inherited] |
static phpCAS::isAuthenticated | ( | ) | [static, inherited] |
static phpCAS::isSessionAuthenticated | ( | ) | [static, inherited] |
static phpCAS::logout | ( | $ | params = "" |
) | [static, inherited] |
This method is used to logout from CAS. $params an array that contains the optional url and service parameters that will be passed to the CAS server
Definition at line 1430 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.
$service | a URL that will be transmitted to the CAS server |
Definition at line 1460 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.
$service | a URL that will be transmitted to the CAS server | |
$url | a URL that will be transmitted to the CAS server |
Definition at line 1504 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.
$url | a URL that will be transmitted to the CAS server |
Definition at line 1481 of file CAS.php.
References phpCAS::error(), phpCAS::traceBegin(), and phpCAS::traceEnd().
static phpCAS::renewAuthentication | ( | ) | [static, inherited] |
static phpCAS::retrievePT | ( | $ | target_service, | |
&$ | err_code, | |||
&$ | err_msg | |||
) | [static, inherited] |
Retrieve a Proxy Ticket from the CAS server.
Definition at line 1580 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:
$n | an integer. |
Definition at line 979 of file CAS.php.
References phpCAS::error().
static phpCAS::setCasServerCACert | ( | $ | cert | ) | [static, inherited] |
Set the certificate of the CAS server CA.
$cert | the CA certificate |
Definition at line 1596 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.
$url | the URL |
Definition at line 1531 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.
$url | the URL |
Definition at line 1553 of file CAS.php.
References phpCAS::error(), phpCAS::traceBegin(), and phpCAS::traceEnd().
static phpCAS::setNoCasServerValidation | ( | ) | [static, inherited] |
Set no SSL validation for the CAS server.
Definition at line 1612 of file CAS.php.
References phpCAS::error(), phpCAS::traceBegin(), and phpCAS::traceEnd().
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
Definition at line 1629 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.
callback | $function | |
optional | array $additionalArgs |
Definition at line 1008 of file CAS.php.
References phpCAS::error().
static phpCAS::setServerLoginURL | ( | $ | url = '' |
) | [static, inherited] |
static phpCAS::setServerLogoutURL | ( | $ | url = '' |
) | [static, inherited] |
Set the logout URL of the CAS server.
$url | the logout URL |
Definition at line 1410 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
$url | the proxyValidate URL |
Definition at line 1356 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.
$url | the samlValidate URL |
Definition at line 1376 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
$url | the serviceValidate URL |
Definition at line 1335 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).
callback | $function | |
optional | array $additionalArgs |
Definition at line 1030 of file CAS.php.
References phpCAS::error().