Login related definitions and functions.
$Id$
Login configuration error status code.
Used by the login code to indicate an error that requires reauthentication because of an error in the login configuration. Most of the time this will fail continually until the administrator intervenes, but at least with this status the theme can present a reason for failing logins.
Authentication expired status code.
Used by the login code to indicate an error that requires reauthentication because the authentication cookie has expired.
Failed login status code.
Used by the login code to indicate an error that requires reauthentication because the previous login attempt failed.
Not enough privileges status code.
Used by the login code to indicate an error that requires reauthentication because the previous login attempt succeeded but the autenticated user does not have enough privileges.
Login required status code.
Used by the login code to indicate that authentication is required.
Change password status code.
Used by the password change code to indicate the initiation of a password change.
Password mismatch status code.
Used by the password change code to indicate an error that requires re-entering of the password information because the newly chosen password fields did not match.
Wrong password status code.
Used by the password change code to indicate an error that requires re-entering of the password information because the password entered was not correct for the user changing the password.
Ticket signature verification error code.
Value returned by the verifyTicket function when there was an error verifying the ticket signature.
Expired ticket error code.
Value returned by the verifyTicket function when the ticket signature is valid but it has expired.
Invalid ticket signature error code.
Value returned by the verifyTicket function when the ticket signature is invalid.
No ticket status code
Value returned by the verifyTicket function when the user did not present a ticket with this request.
Allows users to change their password before continuing the page.
This function will not return unless the change password process has been completed (and will in fact redirect the user to the change password page in the meantime).
Default redirect url for login procedures, for when a user explicitly requests a login or logout page and so we don't know where to go at the end of the request.
Determine whether the current user has a certain privilege (out of a set).
This returns true if the current user was granted the specified privilege, or one out of the set of specified privileges.
List privileges for a user.
Returns an array of privilege names that the requested user has. If no user was specified, it returns the privileges for the current user. If the specified user id was not found, it returns -1.
Returns true if a user is succesfully authenticated.
Logs out the current user before continuing the page.
This function will not return unless the logout process has been completed.
Construct the sws login related URL.
Return true if the current request was for the login host.
Determine whether privilege $priv is in the set $set.
Requires an authenticated user before continuing with the page.
This function must be called before anything is output to the browser. It requires that a valid user has authenticated, and optionally requires specific privilege(s). This function does not return unless these requirements are met (and will in fact redirect the user to another page to present his credentials if those requirements are not met).
Verifies and returns the user's decrypted ticket cookie.
This function is the heart of the user authentication system. It tries to verify the user's ticket cookie by decoding it, verifying it cryptographically, and then testing whether it has expired.
Documentation generated on Fri, 30 Jun 2006 10:31:37 +0200 by phpDocumentor 1.3.0RC3