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

FreeBSD Manual Pages

  
 
  

home | help
CGI::Application::CGI:UserlContributeduPerl:Documentationn::Driver::Generic(3)

NAME
       CGI::Application::Plugin::Authentication::Driver::Generic - Generic
       Authentication driver

SYNOPSIS
	use base qw(CGI::Application);
	use CGI::Application::Plugin::Authentication;

	 __PACKAGE__->authen->config(
	       DRIVER => [ 'Generic', {	user1 => '123',	user2 => '123' } ],
	 );

DESCRIPTION
       This Driver offers a simple way to provide a user database to the
       CGI::Application::Plugin::Authentication	plugin.	 It offers three ways
       to provide a list of users to the plugin	by providing a hash of
       username/password pairs,	an array of arrays containing the username and
       password	pairs, or a code reference that	returns	back the username, or
       undef on	success	or failure.

EXAMPLE
	 my %users = (
	   user1 => '123',
	   user2 => '123',
	 );
	 __PACKAGE__->authen->config(
	       DRIVER => [ 'Generic', \%users ],
	 );

	 - or -

	 my @users = (
	   ['example.com', 'user1', '123'],
	   ['example.com', 'user2', '123'],
	   ['foobar.com', 'user1', '123'],
	 );
	 __PACKAGE__->authen->config(
	       DRIVER => [ 'Generic', \@users ],
	       CREDENTIALS => [	'authen_domain', 'authen_username', 'authen_password' ]
	 );

	 - or -

	 sub check_password {
	   my @credentials = @_;
	   if ($credentials[0] eq 'test' && $credentials[1] eq 'secret') {
	       return 'testuser';
	   }
	   return;
	 }

	 __PACKAGE__->authen->config(
	       DRIVER => [ 'Generic', \&check_password ],
	 );

METHODS
   verify_credentials
       This method will	test the provided credentials against either the hash
       ref, array ref or code ref that the driver was configured with.

SEE ALSO
       CGI::Application::Plugin::Authentication::Driver,
       CGI::Application::Plugin::Authentication, perl(1)

LICENCE	AND COPYRIGHT
       Copyright (c) 2005, SiteSuite. All rights reserved.

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

DISCLAIMER OF WARRANTY
       BECAUSE THIS SOFTWARE IS	LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
       FOR THE SOFTWARE, TO THE	EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
       WHEN OTHERWISE STATED IN	WRITING	THE COPYRIGHT HOLDERS AND/OR OTHER
       PARTIES PROVIDE THE SOFTWARE "AS	IS" WITHOUT WARRANTY OF	ANY KIND,
       EITHER EXPRESSED	OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
       ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF	THE SOFTWARE IS	WITH
       YOU. SHOULD THE SOFTWARE	PROVE DEFECTIVE, YOU ASSUME THE	COST OF	ALL
       NECESSARY SERVICING, REPAIR, OR CORRECTION.

       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR	AGREED TO IN WRITING
       WILL ANY	COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
       REDISTRIBUTE THE	SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
       TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
       CONSEQUENTIAL DAMAGES ARISING OUT OF THE	USE OR INABILITY TO USE	THE
       SOFTWARE	(INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
       RENDERED	INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
       FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
       SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
       DAMAGES.

perl v5.24.1	  CGI::Application::Plugin::Authentication::Driver::Generic(3)

NAME | SYNOPSIS | DESCRIPTION | EXAMPLE | METHODS | SEE ALSO | LICENCE AND COPYRIGHT | DISCLAIMER OF WARRANTY

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=CGI::Application::Plugin::Authentication::Driver::Generic&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help