.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Authen::Simple::DBM 3pm"
.TH Authen::Simple::DBM 3pm "2022-06-08" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Authen::Simple::DBM \- Simple DBM authentication
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Authen::Simple::DBM;
\&
\& my $dbm = Authen::Simple::DBM\->new(
\& path => \*(Aq/var/db/www/passwd\*(Aq
\& );
\&
\& 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"
\&
\&
\& PerlAuthenHandler Authen::Simple::DBM
\& AuthType Basic
\& AuthName "Protected Area"
\& Require valid\-user
\&
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\s-1DBM\s0 authentication.
.SH "METHODS"
.IX Header "METHODS"
.IP "\(bu" 4
new
.Sp
This method takes a hash of parameters. The following options are
valid:
.RS 4
.IP "\(bu" 8
path
.Sp
Path to \s-1DBM\s0 file. Usually specified without trailing \f(CW\*(C`.db\*(C'\fR, \f(CW\*(C`.pag\*(C'\fR
or \f(CW\*(C`.dir\*(C'\fR suffix. Required.
.Sp
.Vb 1
\& path => \*(Aq/var/db/www/passwd\*(Aq
.Ve
.IP "\(bu" 8
type
.Sp
\&\s-1DBM\s0 type. Valid options are: \f(CW\*(C`DB\*(C'\fR, \f(CW\*(C`GDBM\*(C'\fR, \f(CW\*(C`NDBM\*(C'\fR and \f(CW\*(C`SDBM\*(C'\fR. Defaults to \f(CW\*(C`SDBM\*(C'\fR.
.Sp
.Vb 1
\& type => \*(AqNDBM\*(Aq
.Ve
.RS 8
.IP "\(bu" 12
\&\s-1CDB\s0
.Sp
Constant Database
.IP "\(bu" 12
\&\s-1DB\s0
.Sp
Berkeley \s-1DB\s0
.IP "\(bu" 12
\&\s-1GDBM\s0
.Sp
\&\s-1GNU\s0 Database Mandager
.IP "\(bu" 12
\&\s-1NDBM\s0
.Sp
New Database Mandager. \f(CW\*(C`path\*(C'\fR should be specified without a trailing \f(CW\*(C`.db\*(C'\fR
suffix.
.IP "\(bu" 12
\&\s-1SDBM\s0
.Sp
Substitute Database Mandager. Comes with both with perl and Apache. \f(CW\*(C`path\*(C'\fR
should be specified without a trailing \f(CW\*(C`.pag\*(C'\fR or \f(CW\*(C`.dir\*(C'\fR suffix.
.RE
.RS 8
.RE
.IP "\(bu" 8
log
.Sp
Any object that supports \f(CW\*(C`debug\*(C'\fR, \f(CW\*(C`info\*(C'\fR, \f(CW\*(C`error\*(C'\fR and \f(CW\*(C`warn\*(C'\fR.
.Sp
.Vb 1
\& log => Log::Log4perl\->get_logger(\*(AqAuthen::Simple::DBM\*(Aq)
.Ve
.RE
.RS 4
.RE
.IP "\(bu" 4
authenticate( \f(CW$username\fR, \f(CW$password\fR )
.Sp
Returns true on success and false on failure.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Authen::Simple.
.PP
Authen::Simple::Password.
.PP
\&\fBhtdbm\fR\|(1)
.PP
\&\fBdbmmanage\fR\|(1)
.PP
\- Overview of various \s-1DBM\s0's.
.PP
\- \s-1CDB\s0
.PP
AnyDBM_File \- Compares different \s-1DBM\s0's
.SH "AUTHOR"
.IX Header "AUTHOR"
Christian Hansen \f(CW\*(C`ch@ngmedia.com\*(C'\fR
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
This program is free software, you can redistribute it and/or modify
it under the same terms as Perl itself.