Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Authen::Simple::DBI(3)User Contributed Perl DocumentatioAuthen::Simple::DBI(3)

NAME
       Authen::Simple::DBI - Simple DBI	authentication

SYNOPSIS
	   use Authen::Simple::DBI;

	   my $dbi = Authen::Simple::DBI->new(
	       dsn	 => 'dbi:SQLite:dbname=database.db',
	       statement => 'SELECT password FROM users	WHERE username = ?'
	   );

	   if (	$dbi->authenticate( $username, $password ) ) {
	       # successfull authentication
	   }

	   # or	as a mod_perl Authen handler

	   PerlModule Apache::DBI
	   PerlModule Authen::Simple::Apache
	   PerlModule Authen::Simple::DBI

	   PerlSetVar AuthenSimpleDBI_dsn	"dbi:SQLite:dbname=database.db"
	   PerlSetVar AuthenSimpleDBI_statement	"SELECT	password FROM users WHERE username = ?"

	   <Location /protected>
	     PerlAuthenHandler Authen::Simple::DBI
	     AuthType	       Basic
	     AuthName	       "Protected Area"
	     Require	       valid-user
	   </Location>

DESCRIPTION
       DBI authentication.

METHODS
       o   new

	   This	method takes a hash of parameters. The following options are
	   valid:

	   o	   dsn

		   Database Source Name. Required.

		       dsn => 'dbi:SQLite:dbname=database.db'
		       dsn => 'dbi:mysql:database=database;host=localhost;'

	   o	   statement

		   SQL statement. The statement	must take a single string
		   argument (username) and return a single value (password).
		   Required.

		       statement => 'SELECT password FROM users	WHERE username = ?'

	   o	   username

		   Database username.

		       username	=> 'username'

	   o	   password

		   Database password.

		       password	=> 'secret'

	   o	   log

		   Any object that supports "debug", "info", "error" and
		   "warn".

		       log => Log::Log4perl->get_logger('Authen::Simple::DBI')

       o   authenticate( $username, $password )

	   Returns true	on success and false on	failure.

SEE ALSO
       Authen::Simple.

       Authen::Simple::Password.

       DBI.

AUTHOR
       Christian Hansen	"ch@ngmedia.com"

COPYRIGHT
       This program is free software, you can redistribute it and/or modify it
       under the same terms as Perl itself.

perl v5.24.1			  2017-07-03		Authen::Simple::DBI(3)

NAME | SYNOPSIS | DESCRIPTION | METHODS | SEE ALSO | AUTHOR | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Authen::Simple::DBI&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help