Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

authen::simple::dbm(3pm) [debian man page]

Authen::Simple::DBM(3pm)				User Contributed Perl Documentation				  Authen::Simple::DBM(3pm)

NAME

       Authen::Simple::DBM - Simple DBM authentication

SYNOPSIS

	   use Authen::Simple::DBM;

	   my $dbm = Authen::Simple::DBM->new(
	       path => '/var/db/www/passwd'
	   );

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

	   # or as a mod_perl Authen handler

	   PerlModule Authen::Simple::Apache
	   PerlModule Authen::Simple::DBM

	   PerlSetVar AuthenSimpleDBM_path "/var/db/www/passwd"

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

DESCRIPTION

       DBM authentication.

METHODS

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

	   * path  Path to DBM file. Usually specified without trailing ".db", ".pag" or ".dir" suffix. Required.

		       path => '/var/db/www/passwd'

	   * type  DBM type. Valid options are: "DB", "GDBM", "NDBM" and "SDBM". Defaults to "SDBM".

		       type => 'NDBM'

		   * CDB       Constant Database

		   * DB        Berkeley DB

		   * GDBM      GNU Database Mandager

		   * NDBM      New Database Mandager. "path" should be specified without a trailing ".db" suffix.

		   * SDBM      Substitute Database Mandager. Comes with both with perl and Apache. "path" should be specified without a trailing
			       ".pag" or ".dir" suffix.

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

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

       * authenticate( $username, $password )
	   Returns true on success and false on failure.

SEE ALSO

       Authen::Simple.

       Authen::Simple::Password.

       htdbm(1)

       dbmmanage(1)

       <http://www.unixpapa.com/incnote/dbm.html> - Overview of various DBM's.

       <http://cr.yp.to/cdb.html> - CDB

       AnyDBM_File - Compares different DBM's

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.8.8							    2008-03-01						  Authen::Simple::DBM(3pm)

Check Out this Related Man Page

HTTP::Server::Simple::Authen(3pm)			User Contributed Perl Documentation			 HTTP::Server::Simple::Authen(3pm)

NAME

       HTTP::Server::Simple::Authen - Authentication plugin for HTTP::Server::Simple

SYNOPSIS

	 package MyServer;
	 use base qw( HTTP::Server::Simple::Authen HTTP::Server::Simple::CGI);

	 use Authen::Simple::Passwd;
	 sub authen_handler {
	     Authen::Simple::Passwd->new(passwd => '/etc/passwd');
	 }

	 sub handle_request {
	     my($self, $cgi) = @_;
	     my $user = $self->authenticate or return;
	     ...
	 }

	 MyServer->new->run();

DESCRIPTION

       HTTP::Server::Simple::Authen is an HTTP::Server::Simple plugin to allow HTTP authentication. Authentication scheme is pluggable and you can
       use whatever Authentication protocol that Authen::Simple supports.

       You can use "authenticate" method whatever you want to authenticate the request. The method returns $username taken from the request if the
       authentication is successful, and "undef" otherwise. The code in "SYNOPSIS" requires authentication for all the requests and behaves just
       the same as Apache's "Require valid-user".

       The following code will explain more about conditioning.

	 sub handle_request {
	     my($self, $cgi) = @_;
	     if ($cgi->path_info =~ m!/foo/!) {
		 my $user = $self->authenticate;
		 return unless defined($user) && length($user) == 8;
	     }
	     ...
	 }

       This means all the requests to URL "/foo/" require to be authenticated, and usernames with 8 chars long are authorized.

METHODS

       Your subclass has to override following methods to implement HTTP authentication.

       authen_handler
	   Should return a valid Authen::Simple instance to authenticate HTTP request (Required).

       authen_realm
	   Returns a string for Authentication realm to be shown in the browser's dialog box. Defaults to 'Authorized area'.

AUTHOR

       Tatsuhiko Miyagawa <miyagawa@bulknews.net>

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

SEE ALSO

       HTTP::Server::Simple, Authen::Simple

perl v5.12.3							    2006-01-15					 HTTP::Server::Simple::Authen(3pm)
Man Page