• Home
• CAS_Client

PHP Class CAS_Client

显示文件 Open project: jasig/phpcas Class Usage Examples

Public Methods

Method	Description
__construct ( string $server_version, boolean $proxy, string $server_hostname, integer $server_port, string $server_uri, boolean $changeSessionID = true ) : a	CAS_Client constructor.
addRebroadcastHeader ( string $header ) : void	This method is used to add header parameters when rebroadcasting pgtIou/pgtId or logoutRequest.
addRebroadcastNode ( string $rebroadcastNodeUrl ) : void	Store the rebroadcast node for pgtIou/pgtId and logout requests.
checkAuthentication ( ) : true	This method is called to check whether the user is authenticated or not.
ensureAuthenticationCallSuccessful ( ) : void	Ensure that authentication was checked. Terminate with exception if no authentication was performed
ensureIsProxy ( ) : void	Ensure that this is actually a proxy object or fail with an exception
forceAuthentication ( ) : true	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.
getAllowedProxyChains ( ) : CAS_ProxyChain_AllowedList	Answer the CAS_ProxyChain_AllowedList object for this client.
getAttribute ( string $key ) : string	Get a specific attribute by name
getAttributes ( ) : arry	Get an key values arry of attributes
getAuthenticationCallerFile ( ) : array	Answer information about the authentication caller.
getAuthenticationCallerLine ( ) : array	Answer information about the authentication caller.
getAuthenticationCallerMethod ( ) : array	Answer information about the authentication caller.
getChangeSessionID ( ) : boolean	Get whether phpCas is allowed to change session_id
getLangObj ( ) : CAS_Languages_LanguageInterface	Create the language
getProxiedService ( string $type ) : CAS_ProxiedService	Answer a proxy-authenticated service handler.
getProxies ( ) : array	Answer an array of proxies that are sitting in front of this application.
getServerLoginURL ( boolean $gateway = false, boolean $renew = false ) : a	This method is used to retrieve the login URL of the CAS server.
getServerLogoutURL ( ) : string	This method is used to retrieve the logout URL of the CAS server.
getServerProxyURL ( ) : string	This method is used to retrieve the proxy URL of the CAS server.
getServerProxyValidateURL ( ) : string	This method is used to retrieve the proxy validating URL of the CAS server.
getServerSamlValidateURL ( ) : string	This method is used to retrieve the SAML validating URL of the CAS server.
getServerServiceValidateURL ( ) : string	This method is used to retrieve the service validating URL of the CAS server.
getServerVersion ( ) : string	This method is used to retrieve the version of the CAS server.
getTicket ( ) : string	This method returns the Service Ticket provided in the URL of the request.
getURL ( ) : The	This method returns the URL of the current request (without any ticket CGI parameter).
getUser ( ) : string	This method returns the CAS user's login name.
handleLogoutRequests ( boolean $check_client = true, boolean $allowed_clients = false ) : void	This method handles logout requests.
hasAttribute ( string $key ) : boolean	Check whether a specific attribute with a name is available
hasAttributes ( ) : boolean	Check whether attributes are available
hasTicket ( ) : boolean	This method tells if a Service Ticket was stored.
initializeProxiedService ( CAS_ProxiedService $proxiedService ) : void	Initialize a proxied-service handler with the proxy-ticket it should use.
isAuthenticated ( boolean $renew = false ) : true	This method is called to check if the user is authenticated (previously or by tickets given in the URL).
isProxy ( ) : true	Tells if a CAS client is a CAS proxy or not
isSessionAuthenticated ( ) : true	This method tells if the current session is authenticated.
logout ( array $params ) : void	This method is used to logout from CAS.
markAuthenticationCall ( boolean $auth ) : null	Mark the caller of authentication. This will help client integraters determine problems with their code flow if they call a function such as getUser() before authentication has occurred.
printHTMLFooter ( ) : void	This method prints the footer of the HTML output (after filtering). If CAS_Client::setHTMLFooter() was not used, a default footer is output.
printHTMLHeader ( string $title ) : void	This method prints the header of the HTML output (after filtering). If CAS_Client::setHTMLHeader() was not used, a default header is output.
redirectToCas ( boolean $gateway = false, boolean $renew = false ) : void	This method is used to redirect the client to the CAS server.
renewAuthentication ( ) : true	This method is called to renew the authentication of the user If the user is authenticated, renew the connection If not, redirect to CAS
retrievePT ( string $target_service, &$err_code, &$err_msg ) : a	This method is used to retrieve PT's from the CAS server thanks to a PGT.
serviceMail ( string $url, string $serviceUrl, string $flags, &$err_code, &$err_msg, &$pt ) : object	This method is used to access an IMAP/POP3/NNTP service.
serviceWeb ( string $url, &$err_code, &$output ) : true	This method is used to access an HTTP[S] service.
setAttributes ( array $attributes ) : void	Set an array of attributes
setBaseURL ( string $url ) : string	This method sets the base URL of the CAS server.
setCacheTimesForAuthRecheck ( integer $n ) : void	Set the number of times authentication will be cached before rechecked.
setCallbackURL ( string $url ) : void	This method sets the callback url.
setCasAttributeParserCallback ( string $function, array $additionalArgs = [] ) : void	Set a callback function to be run when parsing CAS attributes
setCasServerCACert ( string $cert, boolean $validate_cn ) : void	Set the CA certificate of the CAS server.
setExtraCurlOption ( string $key, string $value ) : void	This method is used to set additional user curl options.
setHTMLFooter ( string $footer ) : void	This method set the HTML footer used for all outputs.
setHTMLHeader ( string $header ) : void	This method set the HTML header used for all outputs.
setLang ( string $lang ) : void	This method is used to set the language used by phpCAS.
setNoCasServerValidation ( ) : void	Set no SSL validation for the CAS server.
setNoClearTicketsFromUrl ( ) : void	Configure the client to not send redirect headers and call exit() on authentication success. The normal redirect is used to remove the service ticket from the client's URL, but for running unit tests we need to continue without exiting.
setPGTStorage ( CAS_PGTStorage_AbstractStorage $storage ) : void	This method can be used to set a custom PGT storage object.
setPGTStorageDb ( string $dsn_or_pdo, string $username = '', string $password = '', string $table = '', string $driver_options = null ) : void	This method is used to tell phpCAS to store the response of the CAS server to PGT requests in a database.
setPGTStorageFile ( string $path = '' ) : void	This method is used to tell phpCAS to store the response of the CAS server to PGT requests onto the filesystem.
setPostAuthenticateCallback ( string $function, array $additionalArgs = [] ) : void	Set a callback function to be run when a user authenticates.
setRequestImplementation ( string $className ) : void	Override the default implementation used to make web requests in readUrl().
setServerLoginURL ( string $url ) : string	This method sets the login URL of the CAS server.
setServerLogoutURL ( string $url ) : string	This method sets the logout URL of the CAS server.
setServerProxyValidateURL ( string $url ) : string	This method sets the proxyValidate URL of the CAS server.
setServerSamlValidateURL ( string $url ) : string	This method sets the samlValidate URL of the CAS server.
setServerServiceValidateURL ( string $url ) : string	This method sets the serviceValidate URL of the CAS server.
setSingleSignoutCallback ( string $function, array $additionalArgs = [] ) : void	Set a callback function to be run when a single-signout request is received.
setTicket ( string $st ) : void	This method stores the Service Ticket.
setURL ( string $url ) : void	This method sets the URL of the current request
validateCAS10 ( &$validate_url, &$text_response, &$tree_response, boolean $renew = false ) : boolean	This method is used to validate a CAS 1,0 ticket; halt on failure, and sets $validate_url, $text_reponse and $tree_response on success.
validateCAS20 ( &$validate_url, &$text_response, &$tree_response, boolean $renew = false ) : boolean	This method is used to validate a cas 2.0 ST or PT; halt on failure Used for all CAS 2.0 validations
validateSA ( &$validate_url, &$text_response, &$tree_response, boolean $renew = false ) : boolean	This method is used to validate a SAML TICKET; halt on failure, and sets $validate_url, $text_reponse and $tree_response on success. These parameters are used later by CAS_Client::_validatePGT() for CAS proxies.
wasAuthenticationCallSuccessful ( ) : boolean	Answer the result of the authentication call.
wasAuthenticationCalled ( ) : boolean	Answer true if authentication has been checked.

Private Methods

Method	Description
_addAttributeToArray ( array &$attributeArray, string $name, string $value ) : void	Add an attribute value to an array of attributes.
_authError ( string $failure, string $cas_url, boolean $no_response, boolean $bad_response = '', string $cas_response = '', integer $err_code = '', string $err_msg = '' ) : void	This method is used to print the HTML output when the user was not authenticated.
_buildQueryUrl ( string $url, string $query ) : url	This method is used to append query parameters to an url. Since the url might already contain parameter it has to be detected and to build a proper URL
_buildSAMLPayload ( ) : the	This method is used to build the SAML POST body sent to /samlValidate URL.
_callback ( ) : void	This method is called by CAS_Client::CAS_Client() when running in callback mode. It stores the PGT and its PGT Iou, prints its output and halts.
_ensureAuthenticationCalled ( ) : void	Ensure that authentication was checked. Terminate with exception if no authentication was performed
_getCallbackURL ( ) : The	This method returns the URL that should be used for the PGT callback (in fact the URL of the current request without any CGI parameter, except if phpCAS::setFixedCallbackURL() was used).
_getClientUrl ( ) : string	Try to figure out the phpCas client URL with possible Proxys / Ports etc.
_getNodeType ( String $nodeURL ) : string	Determine the node type from the URL.
_getPGT ( ) : string	This method returns the Proxy Granting Ticket given by the CAS server.
_getServerBaseURL ( ) : string	This method is used to retrieve the base URL of the CAS server.
_getServerHostname ( ) : string	This method is used to retrieve the hostname of the CAS server.
_getServerPort ( ) : string	This method is used to retrieve the port of the CAS server.
_getServerURI ( ) : string	This method is used to retrieve the URI of the CAS server.
_getUser ( ) : string	This method returns the CAS user's login name.
_hasAttribute ( string $key ) : boolean	Check whether a specific attribute with a name is available
_hasPGT ( ) : true	This method tells if a Proxy Granting Ticket was stored.
_htmlFilterOutput ( string $str ) : void	This method filters a string by replacing special tokens by appropriate values and prints it. The corresponding tokens are taken into account: - __CAS_VERSION__ - __PHPCAS_VERSION__ - __SERVER_BASE_URL__
_initPGTStorage ( ) : void	This method is used to initialize the storage of PGT's.
_isCallbackMode ( ) : A	This method returns true when the CAs client is running i callback mode, false otherwise.
_isHttps ( ) : boolean	This method checks to see if the request is secured via HTTPS
_isLogoutRequest ( ) : boolean	Check of the current request is a logout request
_loadPGT ( string $pgt_iou ) : mul	This method reads a PGT from its Iou and deletes the corresponding storage entry.
_readExtraAttributesCas20 ( string $success_elements ) : boolean	This method will parse the DOM and pull out the attributes from the XML payload and put them into an array, then put the array into the session.
_readURL ( string $url, &$headers, &$body, &$err_msg ) : true	This method is used to acces a remote URL.
_rebroadcast ( integer $type ) : void	This method rebroadcasts logout/pgtIou requests. Can be LOGOUT,PGTIOU
_removeParameterFromQueryString ( string $parameterName, string $queryString ) : string	Removes a parameter from a query string
_renameSession ( string $ticket ) : void	Renaming the session
_setCallbackMode ( boolean $callback_mode ) : void	This method sets/unsets callback mode.
_setChangeSessionID ( boolean $allowed ) : void	Set a parameter whether to allow phpCas to change session_id
_setPGT ( string $pgt ) : void	This method stores the Proxy Granting Ticket.
_setProxies ( array $proxies ) : void	Set the Proxy array, probably from persistant storage.
_setSessionAttributes ( string $text_response ) : boolean	This method will parse the DOM and pull out the attributes from the SAML payload and put them into an array, then put the array into the session.
_setUser ( string $user ) : void	This method sets the CAS user's login name.
_storePGT ( string $pgt, string $pgt_iou ) : void	This method stores a PGT. Halts on error.
_validatePGT ( &$validate_url, string $text_response, string $tree_response ) : boolean	This method is used to validate a PGT; halt on failure.
_wasPreviouslyAuthenticated ( ) : true	This method tells if the user has already been (previously) authenticated by looking into the session variables.

Method Details