Authentication
[Implementation]

Functions
	CASClient::setUser ($user)
	CASClient::getUser ()
	CASClient::renewAuthentication ()
	CASClient::forceAuthentication ()
	CASClient::setCacheTimesForAuthRecheck ($n)
	CASClient::checkAuthentication ()
	CASClient::isAuthenticated ()
	CASClient::isSessionAuthenticated ()
	CASClient::wasPreviouslyAuthenticated ()
	CASClient::redirectToCas ($gateway=false, $renew=false)
	CASClient::logout ($params)
	CASClient::isLogoutRequest ()
	CASClient::isLogoutRequestAllowed ()
	CASClient::handleLogoutRequests ($check_client=true, $allowed_clients=false)
Variables
	CASClient::$_user
	CASClient::$_cache_times_for_auth_recheck

---

Function Documentation

CASClient::checkAuthentication

(

)

[inherited]

This method is called to check whether the user is authenticated or not.

Returns:

TRUE when the user is authenticated, FALSE otherwise.

Definition at line 728 of file client.php.

References CASClient::isAuthenticated(), CASClient::redirectToCas(), phpCAS::trace(), phpCAS::traceBegin(), and phpCAS::traceEnd().

CASClient::forceAuthentication

(

)

[inherited]

This method is called to be sure that the user is authenticated. When not authenticated, halt by redirecting to the CAS server; otherwise return TRUE.

Returns:

TRUE when the user is authenticated; otherwise halt.

Definition at line 682 of file client.php.

References CASClient::isAuthenticated(), CASClient::redirectToCas(), phpCAS::trace(), phpCAS::traceBegin(), and phpCAS::traceEnd().

CASClient::getUser

(

)

[inherited]

This method returns the CAS user's login name.

Warning:

should be called only after CASClient::forceAuthentication() or CASClient::isAuthenticated(), otherwise halt with an error.

Returns:

the login name of the authenticated user

Definition at line 648 of file client.php.

References phpCAS::error().

Referenced by CASClient::isAuthenticated().

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

This method handles logout requests.

Parameters:

	$check_client	true to check the client bofore handling the request, false not to perform any access control. True by default.
	$allowed_clients	an array of host names allowed to send logout requests. By default, only the CAs server (declared in the constructor) will be allowed.

Definition at line 997 of file client.php.

References phpCAS::error(), CASClient::getServerHostname(), CASClient::isLogoutRequest(), phpCAS::log(), phpCAS::traceBegin(), phpCAS::traceEnd(), and phpCAS::traceExit().

CASClient::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 785 of file client.php.

References CASClient::getPGT(), CASClient::getPT(), CASClient::getST(), CASClient::getUser(), CASClient::hasST(), CASClient::isProxy(), phpCAS::trace(), phpCAS::traceBegin(), phpCAS::traceEnd(), CASClient::validatePGT(), CASClient::validatePT(), and CASClient::wasPreviouslyAuthenticated().

Referenced by CASClient::checkAuthentication(), CASClient::forceAuthentication(), and CASClient::renewAuthentication().

CASClient::isLogoutRequest

(

)

[private, inherited]

Returns:

true if the current request is a logout request.

Definition at line 978 of file client.php.

Referenced by CASClient::CASClient(), and CASClient::handleLogoutRequests().

CASClient::isLogoutRequestAllowed

(

)

[private, inherited]

Returns:

true if a logout request is allowed.

Definition at line 986 of file client.php.

CASClient::isSessionAuthenticated

(

)

[inherited]

This method tells if the current session is authenticated.

Returns:

true if authenticated based soley on $_SESSION variable

Since:

0.4.22 by Brendan Arnold

Definition at line 837 of file client.php.

Referenced by CASClient::wasPreviouslyAuthenticated().

CASClient::logout

(

$

params

)

[inherited]

This method is used to logout from CAS.

Parameters:

$url

a URL that will be transmitted to the CAS server (to come back to when logged out) 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 953 of file client.php.

References CASClient::getServerLogoutURL(), CASClient::getString(), CASClient::printHTMLFooter(), CASClient::printHTMLHeader(), phpCAS::traceBegin(), and phpCAS::traceExit().

CASClient::redirectToCas	(	$	gateway = false,
		$	renew = false
	)			[inherited]

This method is used to redirect the client to the CAS server. It is used by CASClient::forceAuthentication() and CASClient::checkAuthentication().

Parameters:

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

Definition at line 910 of file client.php.

References CASClient::getServerLoginURL(), CASClient::getString(), phpCAS::log(), CASClient::printHTMLFooter(), CASClient::printHTMLHeader(), phpCAS::traceBegin(), and phpCAS::traceExit().

Referenced by CASClient::checkAuthentication(), CASClient::forceAuthentication(), and CASClient::renewAuthentication().

CASClient::renewAuthentication

(

)

[inherited]

This method is called to renew the authentication of the user If the user is authenticated, renew the connection If not, redirect to CAS

Definition at line 662 of file client.php.

References CASClient::isAuthenticated(), CASClient::redirectToCas(), phpCAS::trace(), phpCAS::traceBegin(), and phpCAS::traceEnd().

CASClient::setCacheTimesForAuthRecheck

(

$

n

)

[inherited]

Set the number of times authentication will be cached before rechecked.

Parameters:

$n

an integer.

Definition at line 718 of file client.php.

CASClient::setUser

(

$

user

)

[private, inherited]

This method sets the CAS user's login name.

Parameters:

$user

the login name of the authenticated user.

Definition at line 636 of file client.php.

Referenced by CASClient::validateST(), and CASClient::wasPreviouslyAuthenticated().

CASClient::wasPreviouslyAuthenticated

(

)

[private, inherited]

This method tells if the user has already been (previously) authenticated by looking into the session variables.

Note:

This function switches to callback mode when needed.

Returns:

TRUE when the user has already been authenticated; FALSE otherwise.

Definition at line 852 of file client.php.

References $auth, CASClient::callback(), CASClient::isCallbackMode(), CASClient::isProxy(), CASClient::isSessionAuthenticated(), CASClient::setPGT(), CASClient::setPT(), CASClient::setST(), CASClient::setUser(), phpCAS::trace(), phpCAS::traceBegin(), and phpCAS::traceEnd().

Referenced by CASClient::isAuthenticated().

---

Variable Documentation

CASClient::$_cache_times_for_auth_recheck [private, inherited]

An integer that gives the number of times authentication will be cached before rechecked.

Definition at line 709 of file client.php.

CASClient::$_user [private, inherited]

The Authenticated user. Written by CASClient::setUser(), read by CASClient::getUser().

Attention:

client applications should use phpCAS::getUser().

Definition at line 627 of file client.php.