PEAR Manual
Prev	Chapter 28. Authentication	Next

Auth

Table of Contents
Introduction -- A usage example
Storage drivers -- Introduction
Auth_Container_Array -- Authenticate against an array of usernames and passwords
Auth_Container_DB -- Authenticate against a database using DB
Auth_Container_DBLite -- Authenticate against a database using DB
Auth_Container_File -- Authenticate a password file using File_Passwd
Auth_Container_IMAP -- Authenticate against an IMAP server
Auth_Container_KADM5 -- Authenticate against a Kerberos 5 server
Auth_Container_LDAP -- Authenticate against an LDAP server
Auth_Container_MDB -- Authenticate against a database using MDB
Auth_Container_MDB2 -- Authenticate against a database using MDB2
Auth_Container_PEAR -- Authenticate against the PEAR website
Auth_Container_POP3 -- Authenticate against a POP3 server
Auth_Container_RADIUS -- Authenticate against a RADIUS server
Auth_Container_SAP -- Authenticate against a SAP server
Auth_Container_SMBPasswd -- Authenticate a SAMBA smbpasswd file using File_SMBPasswd
Auth_Container_SOAP -- Authenticate against a SOAP service
Auth_Container_SOAP5 -- Authenticate against a SOAP service
Auth_Container_vpopmail -- Authenticate against a vpopmail service
Custom Auth_Container -- Build a custom storage container
Auth_Frontend_HTML -- Default login form
Constants -- predefined constants
Auth::Auth() -- constructor
Auth::getAuth() -- check for an authenticated user
Auth::getAuthData() -- retrieve extra information stored within the auth session
Auth::getStatus() -- get the current status of the auth session
Auth::getUsername() -- get the username of the authenticated user
Auth::sessionValidThru() -- get the time up to the session is valid
Auth::setAdvancedSecurity() -- Enables advanced security features. Turned off by default
Auth::setAllowLogin() -- Controls if the user will be allowed to login. Turned on by default
Auth::setAuth() -- set a specific user to be marked as logged in
Auth::setAuthData() -- store extra information with the Auth session
Auth::setExpire() -- set expiration time for authentication
Auth::setFailedLoginCallback() -- set a callback for failed login attempts
Auth::setIdle() -- set maximum idle time for authentication
Auth::setLoginCallback() -- set a callback for successful login attempts
Auth::setLogoutCallback() -- set a callback for successful logout attempts
Auth::setSessionName() -- set a custom session name
Auth::setShowLogin() -- controls if the login form will be displayed. Turned on by default
Auth::start() -- start authentication
Auth::checkAuth() -- check if a session with valid authentication information exists
Auth::logout() -- logout an authenticated user
Auth::listUsers() -- list available users
Auth::addUser() -- add a new user
Auth::removeUser() -- remove a user account
Auth::changePassword() -- change the password of a user

Provides a framework for user authentication.