.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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 turned on, 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
.\" ========================================================================
.\"
.IX Title "Catalyst::Authentication::Store::Htpasswd 3pm"
.TH Catalyst::Authentication::Store::Htpasswd 3pm "2016-05-18" "perl v5.22.2" "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"
Catalyst::Authentication::Store::Htpasswd \- Authen::Htpasswd based
user storage/authentication.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    use Catalyst qw/
\&      Authentication
\&    /;
\&
\&    _\|_PACKAGE_\|_\->config(
\&        authentication => {
\&            default_realm => \*(Aqtest\*(Aq,
\&            realms => {
\&                test => {
\&                    credential => {
\&                        class          => \*(AqPassword\*(Aq,
\&                        password_field => \*(Aqpassword\*(Aq,
\&                        password_type  => \*(Aqself_check\*(Aq,
\&                    },
\&                    store => {
\&                        class => \*(AqHtpasswd\*(Aq,
\&                        file => \*(Aqhtpasswd\*(Aq,
\&                    },
\&                },
\&            },
\&        },   
\&    );
\&
\&    sub login : Global {
\&        my ( $self, $c ) = @_;
\&
\&        $c\->authenticate({ username => $c\->req\->param("login"), password => $c\->req\->param("password") });
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This plugin uses Authen::Htpasswd to let your application use \f(CW\*(C`.htpasswd\*(C'\fR
files for it's authentication storage.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
Simple constructor, dies if the htpassword file can't be found
.SS "find_user"
.IX Subsection "find_user"
Looks up the user, and returns a Catalyst::Authentication::Store::Htpasswd::User object.
.SS "user_supports"
.IX Subsection "user_supports"
Delegates to Catalyst::Authentication::User\->supports or an
override in user_class.
.SS "from_session"
.IX Subsection "from_session"
Delegates the user lookup to find_user
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
.SS "file"
.IX Subsection "file"
The path to the htpasswd file. If the path starts with a slash, then it is assumed to be a fully
qualified path, otherwise the path is fed through \f(CW\*(C`$c\->path_to\*(C'\fR and so normalised to the 
application root.
.PP
Alternatively, it is possible to pass in an Authen::Htpasswd object here, and this will be
used as the htpasswd file.
.SS "user_class"
.IX Subsection "user_class"
Change the user class which this store returns. Defaults to Catalyst::Authentication::Store::Htpasswd::User.
This can be used to add additional functionality to the user class by sub-classing it, but will not normally be
needed.
.SS "user_field"
.IX Subsection "user_field"
Change the field that the username is found in in the information passed into the call to \f(CW\*(C`$c\->authenticate()\*(C'\fR.
.PP
This defaults to \fI username \fR, and generally you should be able to use the module as shown in the synopsis, however
if you need a different field name then this setting can change the default.
.PP
Example:
.PP
.Vb 8
\&    _\|_PACKAGE_\|_\->config( authentication => { realms => { test => {
\&                    store => {
\&                        class => \*(AqHtpasswd\*(Aq,
\&                        user_field => \*(Aqemail_address\*(Aq,
\&                    },
\&    }}});
\&    # Later in your code
\&    $c\->authenticate({ email_address => $c\->req\->param("email"), password => $c\->req\->param("password") });
.Ve
.SH "AUTHORS"
.IX Header "AUTHORS"
Yuval Kogman \f(CW\*(C`<nothingmuch@woobling.org\*(C'\fR>
.PP
David Kamholz \f(CW\*(C`<dkamholz@cpan.org\*(C'\fR>
.PP
Tomas Doran \f(CW\*(C`<bobtfish@bobtfish.net\*(C'\fR>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Authen::Htpasswd.
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
.Vb 3
\&        Copyright (c) 2005\-2008 the aforementioned authors. All rights
\&        reserved. This program is free software; you can redistribute
\&        it and/or modify it under the same terms as Perl itself.
.Ve