Authentication
[User interface]


Functions
	phpCAS::setCacheTimesForAuthRecheck ($n)
	phpCAS::checkAuthentication ()
	phpCAS::forceAuthentication ()
	phpCAS::renewAuthentication ()
	phpCAS::authenticate ()
	phpCAS::isAuthenticated ()
	phpCAS::isSessionAuthenticated ()
	phpCAS::getUser ()
	phpCAS::handleLogoutRequests ($check_client=true, $allowed_clients=false)
	phpCAS::getServerLoginURL ()
	phpCAS::setServerLoginURL ($url='')
	phpCAS::getServerLogoutURL ()
	phpCAS::setServerLogoutURL ($url='')
	phpCAS::logout ($params="")
	phpCAS::logoutWithRedirectService ($service)
	phpCAS::logoutWithUrl ($url)
	phpCAS::logoutWithRedirectServiceAndUrl ($service, $url)
	phpCAS::setFixedCallbackURL ($url='')
	phpCAS::setFixedServiceURL ($url)
	phpCAS::getServiceURL ()
	phpCAS::retrievePT ($target_service, &$err_code, &$err_msg)
	phpCAS::setCasServerCert ($cert)
	phpCAS::setCasServerCACert ($cert)
	phpCAS::setNoCasServerValidation ()

Function Documentation

phpCAS::authenticate ( ) [inherited]

This method has been left from version 0.4.1 for compatibility reasons.

Definition at line 954 of file CAS.php.

phpCAS::checkAuthentication ( ) [inherited]

This method is called to check if the user is authenticated (use the gateway feature).

Returns:: TRUE when the user is authenticated; otherwise FALSE.

Examples:: example_gateway.php.

Definition at line 875 of file CAS.php.

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

phpCAS::forceAuthentication ( ) [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.

Examples:: example_db.php, example_file.php, example_gateway.php, example_html.php, example_lang.php, example_proxy.php, example_proxy2.php, example_service.php, example_session_proxy.php, example_session_service.php, and example_simple.php.

Definition at line 902 of file CAS.php.

References $auth, phpCAS::backtrace(), phpCAS::error(), phpCAS::getUser(), phpCAS::trace(), and phpCAS::traceBegin().

phpCAS::getServerLoginURL ( ) [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 1043 of file CAS.php.

References phpCAS::error().

phpCAS::getServerLogoutURL ( ) [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 1079 of file CAS.php.

References phpCAS::error().

phpCAS::getServiceURL ( ) [inherited]

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

Definition at line 1244 of file CAS.php.

References phpCAS::error().

phpCAS::getUser ( ) [inherited]

This method returns the CAS user's login name.

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

Returns:: the login name of the authenticated user

Examples:: example_lang.php.

Definition at line 1010 of file CAS.php.

References phpCAS::error().

Referenced by phpCAS::forceAuthentication().

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

Handle logout requests.

Definition at line 1028 of file CAS.php.

References phpCAS::error().

phpCAS::isAuthenticated ( ) [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 965 of file CAS.php.

phpCAS::isSessionAuthenticated ( ) [inherited]

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

Returns:: true if authenticated, false otherwise.

Since:: 0.4.22 by Brendan Arnold

Definition at line 994 of file CAS.php.

phpCAS::logout ( $ params = "" ) [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

Examples:: example_gateway.php, and example_simple.php.

Definition at line 1114 of file CAS.php.

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

phpCAS::logoutWithRedirectService ( $ service ) [inherited]

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

Parameters:

$service

a URL that will be transmitted to the CAS server

Definition at line 1144 of file CAS.php.

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

phpCAS::logoutWithRedirectServiceAndUrl	(	$	service,
		$	url
	)			`[inherited]`

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

Parameters:

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

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

phpCAS::logoutWithUrl ( $ url ) [inherited]

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

Parameters:

$url

a URL that will be transmitted to the CAS server

Definition at line 1162 of file CAS.php.

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

phpCAS::renewAuthentication ( ) [inherited]

This method is called to renew the authentication.

Definition at line 935 of file CAS.php.

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

Retrieve a Proxy Ticket from the CAS server.

Definition at line 1256 of file CAS.php.

References phpCAS::error().

phpCAS::setCacheTimesForAuthRecheck ( $ n ) [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:

$n

an integer.

Definition at line 859 of file CAS.php.

References phpCAS::error().

phpCAS::setCasServerCACert ( $ cert ) [inherited]

Set the certificate of the CAS server CA.

Parameters:

$cert

the CA certificate

Definition at line 1292 of file CAS.php.

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

phpCAS::setCasServerCert ( $ cert ) [inherited]

Set the certificate of the CAS server.

Parameters:

$cert

the PEM certificate

Definition at line 1273 of file CAS.php.

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

phpCAS::setFixedCallbackURL ( $ url = '' ) [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:

$url

the URL

Definition at line 1204 of file CAS.php.

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

phpCAS::setFixedServiceURL ( $ url ) [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:

$url

the URL

Definition at line 1227 of file CAS.php.

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