LedgerSMB::Auth(3pm)					User Contributed Perl Documentation				      LedgerSMB::Auth(3pm)

NAME

       LedgerSMB::Auth.pm - Provides an abstraction layer for session management and authentication.

SYNOPSIS

       This routine provides an abstraction layer for session management and authentication.  The current application only ships with a simple
       authentication layer using database-native accounts.  Other authentication methods are quite possible though currently every LedgerSMB user
       must be a database user.

METHODS

       Each plugin library must provide the following methods.

       session_check
	   Check whether a session exists and handle failure appropriately.

	   Modules are free to define how failure should be addressed.

       session_create
	   Create a session

       session_destroy
	   Destroy a session.

       get_credentials
	   Get credentials and return them to the application.

	   Must return a hashref with the following entries:

	   login password

       credential_prompt
	   Prompt user for credentials

METHODS PROVIDED IN COMMON

       http_error
	   Send an http error to the browser.

COPYRIGHT

       # Small Medium Business Accounting software # http://www.ledgersmb.org/ # # # Copyright (C) 2006-2011 # This work contains copyrighted
       information from a number of sources all used # with permission.  It is released under the GNU General Public License # Version 2 or, at
       your option, any later version.	See COPYRIGHT file for # details.

perl v5.14.2							    2012-03-26						      LedgerSMB::Auth(3pm)