• 홈
• phpCAS

PHP 클래스 phpCAS

파일 보기 프로젝트 열기: jasig/phpcas 1 사용 예제들

공개 메소드들

메소드	설명
addRebroadcastHeader ( String $header ) : void	This method is used to add header parameters when rebroadcasting pgtIou/pgtId or logoutRequest.
addRebroadcastNode ( string $rebroadcastNodeUrl ) : void	Add a pgtIou/pgtId and logoutRequest rebroadcast node.
allowProxyChain ( CAS_ProxyChain_Interface $proxy_chain ) : void	If you want your service to be proxied you have to enable it (default disabled) and define an accepable list of proxies that are allowed to proxy your service.
checkAuthentication ( ) : true	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)
client ( string $server_version, string $server_hostname, string $server_port, string $server_uri, boolean $changeSessionID = true ) : a	phpCAS client initializer.
error ( string $msg ) : void	This method is used by interface methods to print an error and where the function was originally called from.
forceAuthentication ( ) : boolean	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.
getAttribute ( string $key ) : mixed	Answer an attribute for the authenticated user.
getAttributes ( ) : array	Answer attributes about the authenticated user.
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 ( ) : the	This method returns the URL to be used to login.
getServerLogoutURL ( ) : the	This method returns the URL to be used to login.
getServiceURL ( ) : string	Get the URL that is set as the CAS service parameter.
getUser ( ) : string	This method returns the CAS user's login name.
getVerbose ( ) : boot	Show is verbose mode is on
getVersion ( ) : the	This method returns the phpCAS version.
handleLogoutRequests ( boolean $check_client = true, array $allowed_clients = false ) : void	Handle logout requests.
hasAttribute ( string $key ) : boolean	Answer true if an attribute exists for the authenticated user.
hasAttributes ( ) : boolean	Answer true if there are attributes for the authenticated user.
initializeProxiedService ( CAS_ProxiedService $proxiedService ) : void	Initialize a proxied-service handler with the proxy-ticket it should use.
isAuthenticated ( ) : true	This method is called to check if the user is authenticated (previously or by tickets given in the URL).
isInitialized ( ) : boolean	Answer whether or not the client or proxy has been initialized
isSessionAuthenticated ( ) : boolean	Checks whether authenticated based on $_SESSION. Useful to avoid server calls.
log ( string $str ) : void	Logs a string in debug mode.
logout ( string $params = "" ) : void	This method is used to logout from CAS.
logoutWithRedirectService ( string $service ) : void	This method is used to logout from CAS. Halts by redirecting to the CAS server.
logoutWithRedirectServiceAndUrl ( string $service, string $url ) : void	This method is used to logout from CAS. Halts by redirecting to the CAS server.
logoutWithUrl ( string $url ) : void	This method is used to logout from CAS. Halts by redirecting to the CAS server.
proxy ( string $server_version, string $server_hostname, string $server_port, string $server_uri, boolean $changeSessionID = true ) : a	phpCAS proxy initializer.
renewAuthentication ( ) : void	This method is called to renew the authentication.
retrievePT ( string $target_service, &$err_code, &$err_msg ) : string	Retrieve a Proxy Ticket from the CAS server.
serviceMail ( string $url, string $service, 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 ) : boolean	This method is used to access an HTTP[S] service.
setCacheTimesForAuthRecheck ( integer $n ) : void	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
setCasAttributeParserCallback ( string $function, array $additionalArgs = [] ) : void	Set a callback function to be run when receiving CAS attributes
setCasClient ( CAS_Client $client ) : void	For testing purposes, use this method to set the client to a test double
setCasServerCACert ( string $cert, boolean $validate_cn = true ) : void	Set the certificate of the CAS server CA and if the CN should be properly verified.
setDebug ( string $filename = '' ) : void	Set/unset debug mode
setExtraCurlOption ( string $key, string $value ) : void	Change CURL options.
setFixedCallbackURL ( string $url = '' ) : void	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.
setFixedServiceURL ( string $url ) : void	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.
setHTMLFooter ( string $footer ) : void	This method sets the HTML footer used for all outputs.
setHTMLHeader ( string $header ) : void	This method sets 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	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
setPGTStorage ( CAS_PGTStorage $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.
setServerLoginURL ( string $url = '' ) : void	Set the login URL of the CAS server.
setServerLogoutURL ( string $url = '' ) : void	Set the logout URL of the CAS server.
setServerProxyValidateURL ( string $url = '' ) : void	Set the proxyValidate URL of the CAS server.
setServerSamlValidateURL ( string $url = '' ) : void	Set the samlValidate URL of the CAS server.
setServerServiceValidateURL ( string $url = '' ) : void	Set 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. 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).
setVerbose ( boolean $verbose ) : void	Enable verbose errors messages in the website output This is a security relevant since internal status info may leak an may help an attacker. Default is therefore false
trace ( string $str ) : void	This method is used to log something in debug mode.
traceBegin ( ) : void	This method is used to indicate the start of the execution of a function in debug mode.
traceEnd ( string $res = '' ) : void	This method is used to indicate the end of the execution of a function in debug mode.
traceExit ( ) : void	This method is used to indicate the end of the execution of the program

비공개 메소드들

메소드	설명
_validateClientExists ( ) : void	Checks if a client already exists
_validateProxyExists ( ) : void	Checks of a proxy client aready exists

메소드 상세